Class: TMemoryHeapUsageViolation

Declaration: MemoryHeapExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMemoryHeapException

Inherited By:

TBadUseOfHeapAllocator TBadUseOfMemoryHeap TMemoryHeapHasNoIterator

Purpose:

TMemoryHeapUsageViolation is an exception that is thrown when an attempted action might be legal in another context, but is illegal in the current context.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TMemoryHeapUsageViolation.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::~TMemoryHeapUsageViolation

virtual ~ TMemoryHeapUsageViolation ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::TMemoryHeapUsageViolation

TMemoryHeapUsageViolation (unsigned long reason)
TMemoryHeapUsageViolation ()
TMemoryHeapUsageViolation (const TMemoryHeapUsageViolation & other)

Interface Category:

API.

Purpose:

Creates a TMemoryHeapUsageViolation with the specified reason.
Default constructor.
Copy constructor.

Calling Context:

Called to create a TMemoryHeapUsageViolation with the specified reason.
Called to create a TMemoryHeapUsageViolation object.
Called to copy an object.

Parameters:

unsigned long reason -The reason for the exception.
Takes no parameters.
const TMemoryHeapUsageViolation & other -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::operator=

TMemoryHeapUsageViolation & operator =(const TMemoryHeapUsageViolation & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TMemoryHeapUsageViolation & other -The object to be copied.

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: TMemoryHeapUsageViolation::GetDescriptionIndex

virtual int GetDescriptionIndex () const

Interface Category:

API.

Purpose:

Returns the description index for this exception so that it can be mapped to a platform-specific message.

Calling Context:

Called to obtain the description index for this exception.

Parameters:

Takes no parameters.

Return Value:

The description index for this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TMemoryHeapUsageViolation::SameException

virtual bool SameException (const TStandardException & other) const

Interface Category:

API.

Purpose

Determines if the specified object is equivalent to this object.

Calling Context:

Called to determine if the specified object is equivalent to this object.

Parameters:

const TStandardException & other -The object to be compared to this object.

Return Value:

Returns true if the two objects are equivalent.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

API.

Other Considerations:

None.

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