Class: TSQLNativeCommandHandle

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSQLSimpleCommandHandle

Inherited By:

None.

Purpose:

This concrete class is a counted pointer surrogate for TSQLCommand. It extends the semantics of TSQLSimpleCommandHandle by supporting the execution of native SQL statements. The tradeoff is flexibility and performance for TSQLNativeCommandHandle vs. ease of use for TSQLCommandHandle. Clients obtain SQL command handles from appropriate derived classes such as TSQLStandardCommandHandle.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Providers who supply such classes need to use the following constructor: TSQLNativeCommandHandle(TSQLCommand&); The assignment and copy constructors, and destructor implement the counted pointer protocol that allows multiple command handles for a single command: TSQLNativeCommandHandle(const TSQLNativeCommandHandle& source); TSQLNativeCommandHandle& operator =(const TSQLNativeCommandHandle& right);

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLNativeCommandHandle::TSQLNativeCommandHandle

TSQLNativeCommandHandle ()
TSQLNativeCommandHandle (const TSQLNativeCommandHandle & source)
TSQLNativeCommandHandle (TSQLCommand &)

Interface Category:

API.

Purpose:

Default constructor.
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 TSQLNativeCommandHandle & source -The object to copy.
TSQLCommand & -The master to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLNativeCommandHandle::~TSQLNativeCommandHandle

virtual ~ TSQLNativeCommandHandle ()

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

TSQLNativeCommandHandle & operator =(const TSQLNativeCommandHandle & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLNativeCommandHandle & right -The command 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: TSQLNativeCommandHandle::DefineResultColumn

virtual void DefineResultColumn (TRecordSource :: ColumnPosition, TRecordSource :: ColumnType, const TText &)

Interface Category:

API.

Purpose:

Specify the data type of a column in a record source expected from the datastore as result of executing a data retrieval command (for example, SELECT).

Calling Context:

Call this function directly.

Parameters:

TRecordSource :: ColumnPosition -Specifies the column position.
TRecordSource :: ColumnType -Specifies the column data type.
const TText & -Returns, by fill-in reference, the native data type of the column specified.

Return Value:

None.

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.