Class: TMultipleRootLocatorException

Declaration: MultipleRootLocator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

TMultipleRootLocatorException derives from TStandardException and provides exception handling for classes interacting with multiple root locators. This class publicly defines an enumerated type containing all of the supported exception types for multiple root locators.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Rarely derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TMultipleRootLocatorException::TMultipleRootLocatorException

  1. TMultipleRootLocatorException ()
  2. TMultipleRootLocatorException (const TMultipleRootLocatorException & copyFrom)
  3. TMultipleRootLocatorException (ErrorType errorValue)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.
  3. Creates a TMultipleRootLocatorException object and initializes it with the specified ErrorType errorValue. A TMultipleRootLocatorException's cause can only be set with this constructor.

Calling Context:

  1. Called by the stream-in operators.
  2. Called to copy an object.
  3. 3.Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMultipleRootLocatorException::operator=

TMultipleRootLocatorException & operator =(const TMultipleRootLocatorException & copyFrom)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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: TMultipleRootLocatorException::~TMultipleRootLocatorException

virtual ~ TMultipleRootLocatorException ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMultipleRootLocatorException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called during exception generation. Clients should not call directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMultipleRootLocatorException::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.