Class: TRecord

Declaration: Record.h

Taxonomy Categories:

Member Functions:

~TRecord
GetField
GetFieldCount
operator>>=
operator<<=
TRecord
CreateFieldHandle
Unreachable

Interface Category:

API.

Inherits From:

MCollectible, MReferenceCounted

Inherited By:

None.

Purpose:

This abstract class represents an array of fields. Clients will typically not need this class or its derived classes, but will most often use instances of the associated counted pointer memory management surrogate, TRecordHandle.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecord::~TRecord

virtual ~ TRecord ()

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: TRecord::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 no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

TRecord ()
TRecord (const TRecord &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TRecord & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecord::CreateFieldHandle

virtual TRecordFieldHandle CreateFieldHandle (const TRecordField & field)

Interface Category:

API.

Purpose:

Creates a field handle for a record field. Intended for providers only.

Calling Context:

Called by the GetField member function of a derived class.

Parameters:

const TRecordField & field -The source record field.

Return Value:

A field handle for the specified record field.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecord::Unreachable

virtual void Unreachable ()

Interface Category:

API.

Purpose:

For framework internal debugging.

Calling Context:

This is a Taligent internal member function. It should not be called by the clients.

Parameters:

Takes no parameters.

Return Value:

None.

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.