Class: TSQLTableCatalogHandle

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

TSQLTableCatalogHandle
~TSQLTableCatalogHandle
operator=
FetchSQLTableDescriptor

Interface Category:

API.

Inherits From:

TRecordSourceHandle

Inherited By:

TSQLStandardTableCatalogHandle

Purpose:

This abstract class provides descriptive information for the tables in the data source. Because it derives from TRecordSourceHandle, all relevant record source member functions also apply. Table catalog record sources are obtained by calling the TableCatalog member function of a TSQLConnection instance. Table catalogs describe the tables in a datastore. End users require this information in order to navigate through the data in a datastore. It is also required for client applications managing the transfer of data to and from a datastore, where the structure of application data stored in the datastore is unknown at the time of application construction.

Instantiation:

Abstract class; do not instantiate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLTableCatalogHandle::TSQLTableCatalogHandle

TSQLTableCatalogHandle ()
TSQLTableCatalogHandle (const TSQLTableCatalogHandle &)
TSQLTableCatalogHandle (TRecordSource &)

Interface Category:

API.

Purpose:

Default constructor. Creates a handle to an empty instance.
Copy constructor.
Instantiates and initializes an object.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Called to copy an object.
Called to instantiate and initialize an object.

Parameters:

Takes no parameters.
const TSQLTableCatalogHandle & -The object to copy.
TRecordSource & -The master to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableCatalogHandle::~TSQLTableCatalogHandle

virtual ~ TSQLTableCatalogHandle ()

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: TSQLTableCatalogHandle::operator=

TSQLTableCatalogHandle & operator =(const TSQLTableCatalogHandle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLTableCatalogHandle & -The table catalog to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableCatalogHandle::FetchSQLTableDescriptor

virtual bool FetchSQLTableDescriptor (TSQLTableDescriptorHandle &)

Interface Category:

API.

Purpose:

Returns a handle to the next data-source table description (TSQLTableDescriptorHandle). The returned table handles can be used freely in collection classes and so forth.

Calling Context:

Call this function directly.

Parameters:

TSQLTableDescriptorHandle & -On return, holds a handle to the next data-source table description.

Return Value:

Returns false if there are no more table descriptions in the catalog.

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.