Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
TTypingStoreReadEntry is a friend of TTypingStore and provides protected, synchronized read access to the text data store. Clients who wish to read the text data should instantiate a TTypingStoreReadEntry, then call GetTextForReading.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
This class is designed to be used directly.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TTypingStoreReadEntry (TTypingStore * textToRead)
Interface Category:
API.
Purpose:
Constructs a TTypingStoreReadEntry object for the specified typing store, and calls the typing store's LockTextForReading function to establish a read lock on the text.
Calling Context:
Called, via construction by clients, to establish a read lock on the text of the specified typing store.
Parameters:
- TTypingStore * textToRead -Pointer to the typing store whose text is to be locked for reading.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
~ TTypingStoreReadEntry ()
Interface Category:
API.
Purpose:
Destructor. Calls the typing store's UnlockTextForReading function to release the read lock on the text.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
const TText * GetTextForReading () const
Interface Category:
API.
Purpose:
Returns a const pointer to the TText object contained by this typing store.
Calling Context:
Clients can call this function to obtain the TText pointer with read access, then use TText API to read the text.
Parameters:
Return Value:
A const pointer to the TText object contained by this typing store.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.