Class: TDocumentMetaDataBin

Declaration: BasicDocumentStorage.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStorageBin

Inherited By:

None.

Purpose:

TDocumentMetaDataBin is a TStorageBin derived class and provides for the storage of the meta data of a document. Meta data includes the document's name, icon, type and other information.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Do not derived from TDocumentMetaBin.

Concurrency:

Not multithread safe.

Resource Use:

TDocumentMetaDataBin manages its own resources.

Member Function: TDocumentMetaDataBin::TDocumentMetaDataBin

TDocumentMetaDataBin (TMultiBinStorageMechanism *)

Interface Category:

API.

Purpose:

Creates a document meta data bin for the specified storage mechanism.

Calling Context:

Call this function directly.

Parameters:

TMultiBinStorageMechanism * -The storage mechanism for which to create a new bin.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentMetaDataBin::~TDocumentMetaDataBin

virtual ~ TDocumentMetaDataBin ()

Interface Category:

API.

Purpose:

Destructor. This function closes the bin if it's opened.

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.

Member Function: TDocumentMetaDataBin::CreateFromMetaData

TDocument * CreateFromMetaData ()

Interface Category:

API.

Purpose:

Creates a new document from the meta data stored in this bin.

Calling Context:

Called to resurrect a document from this bin.

Parameters:

Takes no parameters.

Return Value:

Returns the newly created document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentMetaDataBin::StoreMetaDataOf

void StoreMetaDataOf (const TDocument &)

Interface Category:

API.

Purpose:

Stores the meta data for the specified document.

Calling Context:

Called to store the meta data for a particular document.

Parameters:

const TDocument & -The document whose meta data is to be stored.

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.