Class: TSQLStandardColumnCatalogHandle

Declaration: SQLStandardDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSQLColumnCatalogHandle

Inherited By:

None.

Purpose:

A standard concrete implementation for the TSQLColumnCatalogHandle class. TSQLColumnCatalogHandle 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: TSQLStandardColumnCatalogHandle::TSQLStandardColumnCatalogHandle

TSQLStandardColumnCatalogHandle ()
TSQLStandardColumnCatalogHandle (const TSQLStandardColumnCatalogHandle &)
TSQLStandardColumnCatalogHandle (TRecordSource &, const TSQLTableDescriptorHandle &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Instantiates and initializes a handle.

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 TSQLStandardColumnCatalogHandle & -The object to copy.
TRecordSource & -The record source containing 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: TSQLStandardColumnCatalogHandle::~TSQLStandardColumnCatalogHandle

virtual ~ TSQLStandardColumnCatalogHandle ()

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

TSQLStandardColumnCatalogHandle & operator =(const TSQLStandardColumnCatalogHandle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLStandardColumnCatalogHandle & -The object to copy.

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: TSQLStandardColumnCatalogHandle::FetchSQLColumnDescriptor

virtual bool FetchSQLColumnDescriptor (TSQLColumnDescriptorHandle &)

Interface Category:

API.

Purpose:

Returns, by reference, a handle to the next datastore column description.

Calling Context:

Call this function directly.

Parameters:

TSQLColumnDescriptorHandle & -On return, holds a handle to the next datastore column description.

Return Value:

Returns true if there are more column 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.