Class: TSQLColumnCatalogHandle

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRecordSourceHandle

Inherited By:

TSQLStandardColumnCatalogHandle

Purpose:

This class provides a record source with column catalog information for a given table.

Instantiation:

Always allocate on the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLColumnCatalogHandle::TSQLColumnCatalogHandle

TSQLColumnCatalogHandle ()
TSQLColumnCatalogHandle (const TSQLColumnCatalogHandle &)
TSQLColumnCatalogHandle (TRecordSource &, const TSQLTableDescriptorHandle &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
A constructor that a provider must provide.

Calling Context:

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

Parameters:

Takes no parameters.
const TSQLColumnCatalogHandle & -The object to copy.
TRecordSource & -The record source containing the column catalog information.
const TSQLTableDescriptorHandle & -The table that owns the column catalog.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLColumnCatalogHandle::~TSQLColumnCatalogHandle

virtual ~ TSQLColumnCatalogHandle ()

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

TSQLColumnCatalogHandle & operator =(const TSQLColumnCatalogHandle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLColumnCatalogHandle & -The column 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: TSQLColumnCatalogHandle::FetchSQLColumnDescriptor

virtual bool FetchSQLColumnDescriptor (TSQLColumnDescriptorHandle &)

Interface Category:

API.

Purpose:

Returns, by reference, a handle to the next SQL column description. The returned SQL column handle can be used freely in collection classes, and so on.

Calling Context:

Call this function directly.

Parameters:

TSQLColumnDescriptorHandle & -Returns, by reference, a handle to the next SQL column description.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLColumnCatalogHandle::GetSQLTableDescriptor

const TSQLTableDescriptorHandle & GetSQLTableDescriptor () const

Interface Category:

API.

Purpose:

Providers might find this member function useful in obtaining the table descriptor associated with a column catalog.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a TSQLTableDescriptorHandle table description associated with the given column.

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.