Class: TLocaleException

Declaration: Localization.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TLocaleException is an exception class used by the locale classes. It is thrown when an invalid locale is encountered.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TLocaleException::TLocaleException

TLocaleException ()
TLocaleException (EReason reason)
TLocaleException (const TLocaleException & copy)

Interface Category:

API.

Purpose:

Default constructor.
Create a TLocaleException with the given reason.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called by clients.
Called to copy an object.

Parameters:

Takes no parameters.
EReason reason -The reason this exception was thrown.
const TLocaleException & copy -The exception to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleException::~TLocaleException

virtual ~ TLocaleException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleException::operator=

TLocaleException & operator =(const TLocaleException & rhs)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLocaleException & rhs -The right hand side object.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleException::GetReason

EReason GetReason () const

Interface Category:

API.

Purpose:

Return the reason this exception was thrown.

Calling Context:

Called by clients.

Parameters:

Takes no parameters.

Return Value:

The reason the exception was thrown.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Polymorphic throw operation.

Calling Context:

Called by clients.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLocaleException::operator>>=

virtual TStream & operator >>=(TStream & toStream) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toStream -The stream on which data is to be written.

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

virtual TStream & operator <<= (TStream & fromStream)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromStream -The stream from which data is to be taken.

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

bool operator ==(const TStandardException & other) const

Interface Category:

API.

Purpose:

Comparison operator.

Calling Context:

Called by clients.

Parameters:

const TStandardException & other -The exception to be compared to.

Return Value:

Returns true if the two exceptions were thrown for the same reason.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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