Class: TSQLSimpleCommandHandle

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

TSQLSimpleCommandHandle
~TSQLSimpleCommandHandle
operator=
Execute
GetRecordSource

Interface Category:

API.

Inherits From:

None.

Inherited By:

TSQLCommandHandle TSQLNativeCommandHandle

Purpose:

This concrete class is a counted pointer surrogate for TSQLCommand. It is the base class for TSQLCommandHandle and TSQLNativeCommandHandle. It's intended to declare variables and/or fields that can hold either a TSQLCommandHandle or a TSQLNativeCommandHandle.

Instantiation:

Always allocate on the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLSimpleCommandHandle::TSQLSimpleCommandHandle

TSQLSimpleCommandHandle ()
TSQLSimpleCommandHandle (const TSQLSimpleCommandHandle & source)
TSQLSimpleCommandHandle (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 TSQLSimpleCommandHandle & 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: TSQLSimpleCommandHandle::~TSQLSimpleCommandHandle

virtual ~ TSQLSimpleCommandHandle ()

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

TSQLSimpleCommandHandle & operator =(const TSQLSimpleCommandHandle & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLSimpleCommandHandle & 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: TSQLSimpleCommandHandle::Execute

virtual void Execute ()

Interface Category:

API.

Purpose:

Executes the SQL command.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws an exception on error.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLSimpleCommandHandle::GetRecordSource

virtual const TRecordSourceHandle & GetRecordSource (TRecordSourceHandle &) const

Interface Category:

API.

Purpose:

Returns the record source for the executed SQL command.

Calling Context:

Call this function directly.

Parameters:

TRecordSourceHandle & -On return, holds the the record source for the executed SQL command.

Return Value:

The record source for the executed SQL command.

Exceptions:

Throws an exception if the given command was not a SELECT statement or was not executed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.