Class: TSQLTableDescriptorHandle

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

This concrete class is a counted pointer memory management surrogate for TSQLTableDescriptor. It gives clients access to public member functions of TSQLTableDescriptor. 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:

Always allocate on the stack. Although clients might need to create a TSQLTableDescriptorHandle instance explicitly, most instances are created and returned by calling the FetchSQLTableDescriptor member function of a TSQLTableCatalog record source.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::TSQLTableDescriptorHandle

TSQLTableDescriptorHandle ()
TSQLTableDescriptorHandle (const TSQLTableDescriptorHandle & source)
TSQLTableDescriptorHandle (const TText & table, const TText & owner =TStandardText :: GetEmptyText (), const TText & qualifier =TStandardText :: GetEmptyText (), const TText & type =TStandardText :: GetEmptyText (), const TText & remarks =TStandardText :: GetEmptyText ())
TSQLTableDescriptorHandle (TSQLTableDescriptor & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Instantiates and initializes an object.
Constructs a derived class; providers need to use this constructor.

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.
Called by derived class constructors.

Parameters:

Takes no parameters.
const TSQLTableDescriptorHandle & source -The object to copy.
const TText & table -The table name.
const TText & owner =TStandardText :: GetEmptyText () -The table owner.
const TText & qualifier =TStandardText :: GetEmptyText () -The table qualifier.
const TText & type =TStandardText :: GetEmptyText () -The table type.
const TText & remarks =TStandardText :: GetEmptyText () -Any remarks associated with the table.
TSQLTableDescriptor & source -The master to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::~TSQLTableDescriptorHandle

virtual ~ TSQLTableDescriptorHandle ()

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

TSQLTableDescriptorHandle & operator =(const TSQLTableDescriptorHandle & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLTableDescriptorHandle & right -The table descriptor 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: TSQLTableDescriptorHandle::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator. Streams in an SQL table description.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator. Streams out an SQL table description.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value for object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A hash value for object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::IsSame

virtual bool IsSame (const MCollectible *) const

Interface Category:

API.

Purpose:

Determines if the associated table descriptor is equal to the one pointed to by its argument. Equality requires all members to be equal.

Calling Context:

Call this function directly.

Parameters:

const MCollectible * -The object to compare with this object.

Return Value:

Returns true if the two objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::GetName

const TText & GetName (TText &) const

Interface Category:

API.

Purpose:

Returns the database table name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database table name.

Return Value:

A const reference to the database table name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::GetOwner

const TText & GetOwner (TText &) const

Interface Category:

API.

Purpose:

Returns the database owner name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database owner name.

Return Value:

A const reference to the database owner name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::GetQualifier

const TText & GetQualifier (TText &) const

Interface Category:

API.

Purpose:

Returns the qualifier of the table. The qualifier is typically used for the database name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the qualifier of the table.

Return Value:

A const reference to the qualifier of the table.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::GetType

const TText & GetType (TText &) const

Interface Category:

API.

Purpose:

Returns the database table type name. The type name returned is data source specific, but is typically Table, View, and so forth.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database table type name.

Return Value:

A const reference to the database table type name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::GetRemarks

const TText & GetRemarks (TText &) const

Interface Category:

API.

Purpose:

Returns any remarks associated with the table.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the remarks associated with the table.

Return Value:

A const reference to the remarks associated with the table.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptorHandle::IsEqual

virtual bool IsEqual (const MCollectible *) const

Interface Category:

API.

Purpose:

Determines if this object equals its argument.

Calling Context:

Call this function directly.

Parameters:

const MCollectible * -The object to compare with this object.

Return Value:

Returns true if all members are equal.

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.