Class: TDocumentRegistry

Declaration: DocumentRegistry.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MRemoteCaller, MRemoteCallerNotifier

Inherited By:

None.

Purpose:

The TDocumentRegistry family of classes starts and manages the runtime server processes of documents on the local machine. The registry also provides an index of well know named documents. Document name and reference pairs may be added to the index, and a reference looked up from a name.

Instantiation:

Allocate on the heap or the stack. The TDocumentRegistry object is an interface to the document registry service for the local machine. Instantiating a TDocumentRegistry object does not create a new registry, but rather provides an API for access the machine registry.

Deriving Classes:

Do not derived from TDocumentRegistry.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentRegistry::TDocumentRegistry

TDocumentRegistry ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the stream-in operators and all other clients creating a TDocumentRegistry 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: TDocumentRegistry::~TDocumentRegistry

virtual ~ TDocumentRegistry ()

Interface Category:

API.

Purpose:

Destructor.

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: TDocumentRegistry::AddNamedDocument

void AddNamedDocument (const TDocumentName &, const TDocumentReference &)

Interface Category:

API.

Purpose:

Adds a document name, reference pair to the named document index for the local machine. This index is used to find well known documents such as the clipboard document.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentName & -The name for the document.
const TDocumentReference & -A reference to the actual document.

Return Value:

None.

Exceptions:

Throws TDocumentException(kNameAleadyInDocumentIndex) if the document name is already in the index.

Concurrency:

Not multithread safe.

Other Considerations:

Preconditions:

Assert (LookupNamedDocument(const TDocumentName&) throws exception)
Assert (TDocumentReference is for a valid document).
Assert (LookupNamedDocument(const TDocumentName&) does not throw exception)

Member Function: TDocumentRegistry::DeleteNamedDocument

Interface Category:

API.

Purpose:

Deletes the name and associated reference from the named document index if the name exists.

Calling Context:

You can call this function directly.

Parameters:

const TDocumentName & -The name to delete from the index.

Return Value:

None.

Exceptions:

Throws TDocumentException(kNameNotInDocumentIndex) if the name is not in the index.

Concurrency:

Not multithread safe.

Other Considerations:

Postconditions:

Assert (LookupNamedDocument(const TDocumentName&) throws exception)

Member Function: TDocumentRegistry::LookupNamedDocument

TDocumentReference

Interface Category:

API.

Purpose:

Looks up a reference to a document known to the named document index.

Calling Context:

No Restrictions

Parameters:

const TDocumentName & -The name to look up in index.

Return Value:

TDocumentReference -The reference corresponding to name in the index.

Exceptions:

Throws TDocumentException(kNameNotInDocumentIndex) if the name is not in the index.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.