Class: TInvalidVersionError

Declaration: CollectionException.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TInvalidVersionError is a class that is thrown to indicate exceptions conditions that occur during ReadVersion and WriteVersion.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TInvalidVersionError.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TInvalidVersionError::TInvalidVersionError

TInvalidVersionError ()
TInvalidVersionError (EInvalidVersionError error)
TInvalidVersionError (const TInvalidVersionError &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TInvalidVersionError initialized with the EInvalidVersionError that was passed.
Copy constructor.

Calling Context:

Call this function directly anywhere the creation of a TInvalidVersionError is desired.
Constructs a new exception object using the the Invalid Version error.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
EInvalidVersionError error -The exception ID to use.
const TInvalidVersionError & -The exception to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvalidVersionError::~TInvalidVersionError

virtual ~ TInvalidVersionError ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly 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: TInvalidVersionError::operator=

const TInvalidVersionError & operator =(const TInvalidVersionError &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

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

EInvalidVersionError GetReason () const

Interface Category:

API.

Purpose:

Returns the exception ID associated with this TInvalidVersionError.

Calling Context:

Call this function directly to return the exception ID associated with this TInvalidVersionError.

Parameters:

Takes no parameters.

Return Value:

Returns the EInvalidVersionsErrorID associated with this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInvalidVersionError::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Call this function directly to throw this exception.

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.