Class: TSQLClientError

Declaration: SQLExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSQLException

Inherited By:

None.

Purpose:

This class defines the concrete exceptions that can be thrown by the Data Access Framework as a result of a client error.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLClientError::TSQLClientError

TSQLClientError (EReason err =kOther, const TText & details =TStandardText :: GetEmptyText ())
TSQLClientError (const TSQLClientError &)

Interface Category:

API.

Purpose:

Constructs an exception and initializes it with the specified parameters.
Copy constructor.

Calling Context:

Called to instantiate and initialize an object.
Called to copy an object.

Parameters:

EReason err =kOther -The exception reason.
const TText & details =TStandardText :: GetEmptyText () -The text describing the reason for throwing the exception.
const TSQLClientError & -The exception to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Exceptions are instantiated within the framework itself. Client instantiation is allowed but not expected.

Member Function: TSQLClientError::~TSQLClientError

virtual ~ TSQLClientError ()

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

TSQLClientError & operator =(const TSQLClientError &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLClientError & -The exception 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: TSQLClientError::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Returns the reason for instantiating and throwing the exception.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The exception reason.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLClientError::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws its associated exception.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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