Class: TSQLParameter

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

~TSQLParameter
operator=
MakeNull
TSQLParameter
Unreachable

Interface Category:

API.

Inherits From:

MReferenceCounted

Inherited By:

None.

Purpose:

This class mediates the translation of SQL constants into the native form supported by a particular database protocol or datastore. Clients use the TSQLParameterHandle class, which acts as a memory management surrogate for TSQLParameter. Providers must take care of translating Taligent data types to text constants insertable in an SQL statement.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

To support new types, clients can extend the TSQLParameter class by deriving from it.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLParameter::~TSQLParameter

virtual ~ TSQLParameter ()

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

virtual TSQLParameter & operator =(const int)
virtual TSQLParameter & operator =(const short)
virtual TSQLParameter & operator =(const long)
virtual TSQLParameter & operator =(const double)
virtual TSQLParameter & operator =(const TText &)
virtual TSQLParameter & operator =(const TTime &)
virtual TSQLParameter & operator =(const TSQLTime &)
virtual TSQLParameter & operator =(const TSQLDate &)
virtual TSQLParameter & operator =(const TSQLTimestamp &)
TSQLParameter & operator =(const TSQLParameter & right)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.
Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.

Parameters:

const int -The integer value to assign.
const short -The short value to assign.
const long -The long value to assign.
const double -The double value to assign.
const TText & -The text to assign.
const TTime & -The time to assign.
const TSQLTime & -The SQL time to assign.
const TSQLDate & -The SQL date to assign.
const TSQLTimestamp & -The SQL time stamp to assign.
const TSQLParameter & right -The object to assign.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLParameter::MakeNull

virtual void MakeNull ()

Interface Category:

API.

Purpose:

Assigns the Null value to the associated parameter.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLParameter::TSQLParameter

TSQLParameter ()
TSQLParameter (const TSQLParameter & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

TSQLCommand

TSQLParameterHandle

Calling Context:

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

Parameters:

Takes no parameters.
const TSQLParameter & source -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLParameter::Unreachable

virtual void Unreachable ()

Interface Category:

API.

Purpose:

For framework internal debugging.

Calling Context:

This is an internal member function. It should not be called by the clients.

Parameters:

Takes no parameters.

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.