Class: TRecordShortFieldHandle

Declaration: Record.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRecordFieldHandle

Inherited By:

None.

Purpose:

This concrete class is a memory surrogate class for TRecordShortField class. Clients typically use this class in preference to TRecordShortField.

Instantiation:

Always allocate on the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordShortFieldHandle::TRecordShortFieldHandle

TRecordShortFieldHandle ()
TRecordShortFieldHandle (const TRecordShortFieldHandle & fieldHandle)
TRecordShortFieldHandle (const TRecordFieldHandle & fieldHandle)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates short field handle for the given short field.

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 a field handle.

Parameters:

Takes no parameters.
const TRecordShortFieldHandle & fieldHandle -The object to copy.
const TRecordFieldHandle & fieldHandle -A field with a short data type.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordShortFieldHandle::~TRecordShortFieldHandle

virtual ~ TRecordShortFieldHandle ()

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

TRecordShortFieldHandle & operator =(const TRecordShortFieldHandle & fieldHandle)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRecordShortFieldHandle & fieldHandle -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: TRecordShortFieldHandle::GetValue

virtual short GetValue () const
virtual const short & GetValue (short & target) const

Interface Category:

API.

Purpose:

Fetches the field by reference.
Fetches the field by value.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

short & target -On return, holds the field.
Takes no parameters.

Return Value:

A const reference to, or for the second variant, the value of, the field.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordShortFieldHandle::SetValue

virtual void SetValue (const short & value)

Interface Category:

API.

Purpose:

Sets the value of the field.

Calling Context:

Call this function directly.

Parameters:

const short & value -The new value for the field.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordShortFieldHandle::Replace

virtual void Replace (const TRecordFieldHandle & field)

Interface Category:

API.

Purpose:

Replaces the field with the value of the given field.

Calling Context:

Call this function directly.

Parameters:

const TRecordFieldHandle & field -The field to copy from.

Return Value:

None.

Exceptions:

Throws an exception if the fields are incompatible.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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