![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TDocumentComponentWriteEntry
Purpose:
This is a hierarchical component read lock. It locks the entire component, all of the component's children, and all of the component's ancestors for reading. A TDocumentComponentReadEntry must be created on a component before attempting to obtain a const pointer to a model or a presenter state.
Instantiation:
Always allocate on the stack.
Deriving Classes:
Do not derive from this class.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TDocumentComponentReadEntry (const TDocumentComponentReference &)
- TDocumentComponentReadEntry (const TModelReference &)
- TDocumentComponentReadEntry (const TPresenterStateReference &)
- TDocumentComponentReadEntry ()
Interface Category:
API.
Purpose:
Locks the specified component for reading.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
The default constructor is protected.
~ TDocumentComponentReadEntry ()
Interface Category:
API.
Purpose:
Destructor. Releases the lock on the component.
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.
- void Init (const TDocumentComponentReference &)
- void Init (const TModelReference &)
- void Init (const TPresenterStateReference &)
Interface Category:
API.
Purpose:
- Locks the specified document component reference.
- Locks the specified model reference.
- Locks the specified presenter state reference.
Calling Context:
- Derived classes can call this function directly.
- Derived classes can call this function directly.
- Derived classes can call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws TCompoundDocumentException::kDocumentComponentDoesNotExist if the document component does not exist.
Concurrency:
Not multithread safe.
Other Considerations:
This function is protected.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.