FmtGetFieldHnd

Cicode Programming Reference > Cicode Function Categories > Format Functions Introduction > FmtGetFieldHnd

FmtGetFieldHnd

Gets field data from a format template. Use this function to extract data after a call to StrToFmt(). This function has the same effect as FmtGetField(), except that you use a field handle instead of the field name.

Syntax

FmtGetFieldHnd(hFmt, hField)

hFmt:

The format template handle, returned from the FmtOpen() function. The handle identifies the table where all data on the associated format template is stored.

hField:

The field handle.

Return Value

The data (as a string). If the field does not contain any data, an empty string will be returned.

Related Functions

StrToFmt, FmtFieldHnd

Example

StrToFmt(hFmt,"CV101 Raw Coal Conveyor");

hField=FmtFieldHnd(hFmt,"Name");

Str=FmtGetField(hFmt,hField);

! Str will contain "CV101".