Class: TAliasTo

Declaration: SafePointers.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPointerTo.

Inherited By:

None.

Purpose:

Warning: This class may be removed in the next release. Contains a pointer to an object, but does not own that object. Like all classes derived from TPointerTo, it can be dereferenced (operator * or operator ->) like a regular pointer; but if it contains NIL (0), dereferencing it throws an exception.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You should not derive any classes from TAliasTo.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAliasTo::TAliasTo

TAliasTo (AType * adopt =NIL)
TAliasTo (const TAliasTo < AType > & alias)

Interface Category:

API.

Purpose:

Warning: This function may be removed in the next release.

Creates a TAliasTo that contains a copy of the specified pointer.
Copy constructor.

Calling Context:

Call this function directly to copy the pointer into the wrapper.
Call this function directly to copy an object.

Parameters:

AType * adopt=NIL -The pointer to copy.
const TAliasTo < AType > & alias -The pointer to copy.

Return Value:

None.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAliasTo::operator=

TAliasTo < AType > & operator =(AType * alias)
TAliasTo < AType > & operator =(const TAliasTo < AType > & alias)

Interface Category:

API.

Purpose:

Warning: This function may be removed in the next release.

Copies the pointer.
Copies the pointer.

Calling Context:

Call this function directly to initialize a TAliasTo object from a pointer.
Call this function directly to initialize a TAliasTo object from another TAliasTo object.

Parameters:

AType * alias -The pointer to copy.
const TAliasTo < AType > & alias -The pointer to copy.

Return Value:

A reference to this object.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAliasTo::operatorAType*

operator AType* () const

Interface Category:

API.

Purpose:

Warning: This function may be removed in the next release. Supports implicit conversion of this object to AType*.

Calling Context:

Call this function directly when this object is passed to a function parameter whose formal type is AType*, or assigned to an object of type AType*.

Parameters:

Takes no parameters.

Return Value:

A copy of the pointer contained in this object.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAliasTo::Orphan

AType * Orphan ()

Interface Category:

API.

Purpose:

Warning: This function may be removed in the next release. Returns a copy of the pointer contained in this object, and changes this object to contain NIL.

Calling Context:

Call this function directly to change the pointer contained by this object to NIL.

Parameters:

Takes no parameters.

Return Value:

A copy of the pointer contained in this object.

Exceptions:

Throws no exceptions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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