Class: TNativeOSException

Declaration: KernelExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

This class is to be used by all clients that want to report a native error code.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TNativeOSException::~TNativeOSException

virtual ~ TNativeOSException ()

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: TNativeOSException::GetNativeErrorCode

NATIVE_ERROR_TYPE GetNativeErrorCode () const

Interface Category:

API.

Purpose:

Returns the native OS error code of this exception.

Calling Context:

Called to get the error code.

Parameters:

Takes no parameters.

Return Value:

Returns the NATIVE_ERROR_TYPE error code.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The return value may have to be interpreted differently on different platforms.

Member Function: TNativeOSException::TNativeOSException

TNativeOSException ()
TNativeOSException (NATIVE_ERROR_TYPE NativeErrorCode, unsigned long whatHappened =0)
TNativeOSException (const TNativeOSException & copy)

Interface Category:

API.

Purpose:

Default constructor.
Constructs the object from the error code and error data.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
NATIVE_ERROR_TYPE NativeErrorCode -The error code.
unsigned long whatHappened =0 -The unsigned long error data to be passed.
const TNativeOSException & copy -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TNativeOSException::operator=

TNativeOSException & operator =(const TNativeOSException & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TNativeOSException & copy -The right-hand side of 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: TNativeOSException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws the exception.

Calling Context:

Called by the client code to throw the exception.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws the exception requested.

Concurrency:

Multithread safe.

Other Considerations:

None.

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