Class: TBadUseOfMemoryHeap

Declaration: MemoryHeapExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMemoryHeapUsageViolation

Inherited By:

None.

Purpose:

TBadUseOfMemoryHeap is an exception that is thrown when a heap is used incorrectly. For example, an attempt to modify a read-only heap results in this exception being thrown.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TBadUseOfMemoryHeap.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBadUseOfMemoryHeap::TBadUseOfMemoryHeap

TBadUseOfMemoryHeap (EViolation what)
TBadUseOfMemoryHeap (const TBadUseOfMemoryHeap & other)
TBadUseOfMemoryHeap ()

Interface Category:

API.

Purpose:

Creates a TBadUseOfMemoryHeap for the specified violation.
Copy constructor.
Default constructor.

Calling Context:

Called to create a TBadUseOfMemoryHeap for a specified violation.
Called to copy an object.
Called to create a TBadUseOfMemoryHeap object.

Parameters:

EViolation what -The type of violation.
const TBadUseOfMemoryHeap & other -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBadUseOfMemoryHeap::~TBadUseOfMemoryHeap

virtual ~ TBadUseOfMemoryHeap ()

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: TBadUseOfMemoryHeap::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: TBadUseOfMemoryHeap::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: TBadUseOfMemoryHeap::Violation

virtual EViolation Violation () const

Interface Category:

API.

Purpose:

Returns the violation value associated with this exception.

Calling Context:

Called by exception message formatters.

Parameters:

Takes no parameters.

Return Value:

Returns a violation value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

Member Function: TBadUseOfMemoryHeap::operator=

TBadUseOfMemoryHeap & operator =(const TBadUseOfMemoryHeap & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBadUseOfMemoryHeap & 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: TBadUseOfMemoryHeap::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: TBadUseOfMemoryHeap::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:

Not multithread safe.

Other Considerations:

None.

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