Class: TDocumentComponentWriteEntry

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDocumentComponentReadEntry

Inherited By:

None.

Purpose:

This is a hierarchical component write lock. It locks the entire component, all of the component's children, and all of the component's ancestors for writing. A TDocumentComponentWriteEntry must be created on a component before attempting to obtain a non-const pointer to a model or 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.

Member Function: TDocumentComponentWriteEntry::TDocumentComponentWriteEntry

TDocumentComponentWriteEntry (const TDocumentComponentReference &)
TDocumentComponentWriteEntry (const TModelReference &)
TDocumentComponentWriteEntry (const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Locks the specified component for writing.

Calling Context:

Call this function directly.

Parameters:

const TDocumentComponentReference & -The component to lock.
const TModelReference & -The unique model inside the component that is to be locked.
const TPresenterStateReference & -The unique presenter state inside the component that is to be locked.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentWriteEntry::~TDocumentComponentWriteEntry

~ TDocumentComponentWriteEntry ()

Interface Category:

API.

Purpose:

Destructor. Releases the lock on the component.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

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.