Class: TRecordHandle

Declaration: Record.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

This concrete class is the counted pointer memory management surrogate for TRecord and its derived classes. Clients should obtain record handles for records from classes such as TRecordSource.

Instantiation:

Always allocate on the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordHandle::TRecordHandle

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Instantiates and initializes a handle.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Called to copy an object.
Called to instantiate and initialize an object.

Parameters:

Takes no parameters.
const TRecordHandle & -The object to copy.
TRecord * record -The master to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordHandle::~TRecordHandle

virtual ~ TRecordHandle ()

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: TRecordHandle::operator=

TRecordHandle & operator =(const TRecordHandle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRecordHandle & -The object to copy.

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: TRecordHandle::GetField

virtual TRecordFieldHandle GetField (FieldPosition) const

Interface Category:

API.

Purpose:

Returns a handle to the field at the given position.

Calling Context:

Call this function directly.

Parameters:

FieldPosition -Specifies the field.

Return Value:

A handle to the field at the given position.

Exceptions:

Throws an exception on invalid positions.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordHandle::GetFieldCount

virtual FieldCount GetFieldCount () const

Interface Category:

API.

Purpose:

Returns the number of fields in the record.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The number of fields in the record.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordHandle::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -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: TRecordHandle::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TRecordHandle::GetRecord

virtual const TRecord & GetRecord () const

Interface Category:

API.

Purpose:

Returns the record associated with the handle.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The record associated with the handle.

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.