Class: TMasterHeapListCorrupted

Declaration: PrimitiveStorageExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Thrown by TMemoryHeap to inform derived classes that the master heap list is corrupted. This class can also be thrown by the placement form of operator new if heap list corruption is detected while looking up the heap of the object specified.

Instantiation:

Always allocate on the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TMasterHeapListCorrupted::~TMasterHeapListCorrupted

virtual ~ TMasterHeapListCorrupted ()

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: TMasterHeapListCorrupted::TMasterHeapListCorrupted

TMasterHeapListCorrupted ()
TMasterHeapListCorrupted (const TMasterHeapListCorrupted & other)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to construct a TMasterHeapListCorrupted object.
Called to copy an object.

Parameters:

Takes no parameters.
const TMasterHeapListCorrupted & other -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMasterHeapListCorrupted::operator=

TMasterHeapListCorrupted & operator =(const TMasterHeapListCorrupted & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TMasterHeapListCorrupted & other -The object to copy.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMasterHeapListCorrupted::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 the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMasterHeapListCorrupted::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 the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMasterHeapListCorrupted::GetDescriptionIndex

virtual int GetDescriptionIndex () const

Interface Category:

API

Purpose:

Obtains an index for descriptive text.

Calling Context:

Called to obtain an index for descriptive text.

Parameters:

Takes no parameters

Return Value:

Returns an index that can be used to obtain descriptive text.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Use TStandardException formatter classes to provide exception descriptions.

Member Function: TMasterHeapListCorrupted::SameException

virtual bool SameException (const TStandardException & other) const

Interface Category:

API

Purpose:

An obsolete function to check the dynamic type of an exception.

Calling Context:

Called to check the dynamic type of an exception.

Parameters:

const TStandardException & other -The exception to match.

Return Value:

Returns true if the passed-in exception is the same as this.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This function is part of the old exception message architecture, and is obsolete.

Member Function: TMasterHeapListCorrupted::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Provides polymorphic rethrowing for this object.

Calling Context:

Called when a exception from which this class is derived is caught and needs to be rethrown as this class.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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