Class: TRecordUnsignedCharField

Declaration: Record.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRecordField

Inherited By:

None.

Purpose:

This concrete class represents a database column of type unsigned char. To instantiate a field, clients typically use the memory surrogate class TRecordUnsignedCharFieldHandle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordUnsignedCharField::TRecordUnsignedCharField

TRecordUnsignedCharField ()
TRecordUnsignedCharField (const unsigned char & value)
TRecordUnsignedCharField (const TRecordUnsignedCharField &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a field with the specified initial value.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const unsigned char & value -The initial value.
const TRecordUnsignedCharField & -The field to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordUnsignedCharField::~TRecordUnsignedCharField

virtual ~ TRecordUnsignedCharField ()

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

TRecordUnsignedCharField & operator =(const TRecordUnsignedCharField & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRecordUnsignedCharField & right -The field 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: TRecordUnsignedCharField::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -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: TRecordUnsignedCharField::GetValue

virtual const unsigned char & GetValue (unsigned char & target) const
virtual unsigned char GetValue () 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:

unsigned char & 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: TRecordUnsignedCharField::SetValue

virtual void SetValue (const unsigned char & value)

Interface Category:

API.

Purpose:

Sets the value of the field.

Calling Context:

Call this function directly.

Parameters:

const unsigned char & 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: TRecordUnsignedCharField::TRecordFieldDeclarationsMacro

TRecordFieldDeclarationsMacro (TRecordUnsignedCharField, TRecordField)

Interface Category:

API.

Purpose:

This macro is used to hide a lot of the repetitive coding required to derive from TRecordField. It ensures that the Name() and DescendsFrom() member functions work as specified for TRecordFieldÕs and TRecordFieldHandleÕs.

Calling Context:

Include this macro in this class directly.

Parameters:

TRecordUnsignedCharField -This class.
TRecordField -The base class of this class.

Return Value:

Implicitly int.

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.