Class: TRecordException

Declaration: Record.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

This class defines the concrete exceptions that can be thrown by the Data Access Framework as a result of unexpected conditions, such as communications disruption caused by a power outage at an offsite RDBMS.

Instantiation:

Allocate on the heap or the stack. Exceptions are instantiated within the framework itself. Client instantiation is allowed but not expected.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordException::TRecordException

TRecordException (EReason reason =kOther)
TRecordException (const TRecordException &)

Interface Category:

API.

Purpose:

Constructs an exception with the specified reason.
Copy constructor.

Calling Context:

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

Parameters:

EReason reason =kOther -The reason for this exception.
const TRecordException & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordException::~TRecordException

virtual ~ TRecordException ()

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

TRecordException & operator =(const TRecordException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRecordException & -The exception to copy.

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: TRecordException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Called when an exception is detected.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordException::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 reason for throwing the exception.

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.