Class: TBadUseOfHeapAllocator

Declaration: StandardHeapExceptions.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMemoryHeapUsageViolation

Inherited By:

None.

Purpose:

TBadUseOfHeapAllocator is thrown when a heap allocation error occurs.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TBadUseOfHeapAllocator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBadUseOfHeapAllocator::TBadUseOfHeapAllocator

TBadUseOfHeapAllocator (EViolation what)
TBadUseOfHeapAllocator (const TBadUseOfHeapAllocator &)
TBadUseOfHeapAllocator ()

Interface Category:

API.

Purpose:

Creates a TBadUseOfHeapAllocator with the specified violation.
Copy constructor.
Default constructor.

Calling Context:

Called to create a TBadUseOfHeapAllocator for a specific violation.
Called to copy an object.
Called to create a TBadUseOfHeapAllocator object.

Parameters:

EViolation what -The violation.
const TBadUseOfHeapAllocator & -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: TBadUseOfHeapAllocator::~TBadUseOfHeapAllocator

virtual ~ TBadUseOfHeapAllocator ()

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

virtual EViolation Violation ()

Interface Category:

API.

Purpose:

Returns the violation enum for this exception.

Calling Context:

Called to set the specific nature of this exception.

Parameters:

Takes no parameters.

Return Value:

Returns the violation enum for this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBadUseOfHeapAllocator::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: TBadUseOfHeapAllocator::operator=

TBadUseOfHeapAllocator & operator =(const TBadUseOfHeapAllocator &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TBadUseOfHeapAllocator & -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: TBadUseOfHeapAllocator::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: TBadUseOfHeapAllocator::SameException

virtual bool SameException (const TStandardException &) const

Interface Category:

API.

Purpose:

Returns true 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.