Class: TShutdownException

Declaration: Shutdown.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TShutdownException is thrown to notify of abnormal conditions in the system shutdown service.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TShutdownException::TShutdownException

TShutdownException ()
TShutdownException (EShutdownExceptionID id)
TShutdownException (const TShutdownException &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a TShutdownException with a specific error ID.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct a TShutdownException with a specific error ID.
Called to copy an object.

Parameters:

Takes no parameters.
EShutdownExceptionID id -The error ID of this exception.
const TShutdownException & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TShutdownException::~TShutdownException

virtual ~ TShutdownException ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TShutdownException::operator=

TShutdownException & operator =(const TShutdownException &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TShutdownException & -The source object for the assignment.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TShutdownException::GetReason

EShutdownExceptionID GetReason () const

Interface Category:

API.

Purpose:

Returns the reason code for this exception.

Calling Context:

Called to determine why the TShutdownException was thrown.

Parameters:

Takes no parameters.

Return Value:

EShutdownExceptionID -The reason code. See EShutdownExceptionID.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TShutdownException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception.

Calling Context:

Called in cases where a polymorphic throw is required, such as when the exception has been streamed across an RPC boundary.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws this TShutdownException.

Concurrency:

Multithread safe.

Other Considerations:

None.

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