Class: TSQLException

Declaration: SQLExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

TSQLAbnormalError TSQLClientError TSQLInternalError

Purpose:

This concrete class describes the exceptions thrown by the Data Access Framework. However, other exceptions can be thrown in response to any given Data Access Framework request.

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: TSQLException::~TSQLException

virtual ~ TSQLException ()

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: TSQLException::TSQLException

TSQLException (const TSQLException &)
TSQLException (long err =0, const TText & details =TStandardText :: GetEmptyText ())

Interface Category:

API.

Purpose:

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

Calling Context:

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

Parameters:

const TSQLException & -The exception to copy.
long err =0 -The error number.
const TText & details =TStandardText :: GetEmptyText () -The text describing the reason for throwing the exception.

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

TSQLException & operator =(const TSQLException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLException & -The exception object 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: TSQLException::GetDetails

virtual const TText & GetDetails (TText &) const

Interface Category:

API.

Purpose:

Returns the reason for instantiating and throwing the exception. Some exceptions can actually be detected outside framework code (for example, RDBMS detected errors). Such errors are usually reported to the Data Access Framework in the form of a textual message that is then passed on to the client using this member function.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the reason for throwing the exception.

Return Value:

A const reference to the reason text.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLException::operator<<=

TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

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

TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

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

bool operator ==(const TStandardException &) const

Interface Category:

API.

Purpose:

Determines if the exception's reason equals that of the argument.

Calling Context:

Call this function directly.

Parameters:

const TStandardException & -The exception to be compared to 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: TSQLException::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.