Class: TExportDocumentQuery

Declaration: ForeignData.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TExportScrapItemsQuery provides a simple interface for exporting an entire document. It iterates over all of the translators on the system, finds the ones which can handle the document's root model, and performs the translation when requested.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TImportForeignDataQuery is intended to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Because TExportDocumentQuery is intended for use as a transient helper object in functions which need to export documents, it is not copyable, assignable, or streamable.

Member Function: TExportDocumentQuery::TExportDocumentQuery

TExportDocumentQuery (const TDocumentReference & docToExport)

Interface Category:

API.

Purpose:

Creates a TExportDocumentQuery object to assist in the export of an entire document.

Calling Context:

Called to create a TExportDocumentQuery object to assist in the export of an entire document.

Parameters:

const TDocumentReference & docToExport -A reference to the document to be exported. The document must be a compound document; otherwise a Document Framework exception will be thrown

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TExportDocumentQuery::~TExportDocumentQuery

virtual ~ TExportDocumentQuery ()

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: TExportDocumentQuery::CopyAvailableTypes

void CopyAvailableTypes (TSequenceOf < TForeignDataType > & types, TMemoryHeap * =0) const

Interface Category:

API.

Purpose:

Returns the types of foreign data that can be created from the document specified in this query's constructor. If no foreign data can be created an exception is thrown.

Calling Context:

You can call this function directly.

Parameters:

TSequenceOf < TForeignDataType > & types -This sequence is filled in with TForeignDataType objects representing all of the foreign data types which can be created from the query's input. The caller is responsible for deleting. the TForeignDataType objects added to the sequence
TMemoryHeap * =0 -The memory heap in which the returned TForeignDataType objects should be created. The default parameter value of 0 will cause the objects to be created in the default heap.

Return Value:

None.

Exceptions:

Throws TForeignDataException(kNoTranslator) if there is no translator which can produce foreign data from the document specified in this query's constructor. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TExportDocumentQuery::DoTranslation

void DoTranslation (const TForeignDataType & desiredType, TForeignData & destination) const

Interface Category:

API.

Purpose:

Performs a translation which produces the requested type of foreign data.

Calling Context:

You can call this function directly.

Parameters:

const TTypeDescription & desiredType -The type of foreign data that is desired as output. This must be one of the types returned by CopyAvailableTypes; otherwise an exception will be thrown.
TForeignData & destination -The foreign data location to which the exported data should be written.

Return Value:

None.

Exceptions:

Throws TForeignDataException(kNoTranslator) if there is no translator which can produce the specified type of foreign data from the document specified in this query's constructor. 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.