Cicode Programming Reference > Cicode Function Categories > String Functions Introduction > StrToFmt

StrToFmt

Converts a string into field data for a format template. This function is useful for splitting a string into separate strings. After the string is converted, you can call the FmtGetField() function to extract the individual data from the template fields.

Syntax

StrToFmt(hFmt, String)

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.

String:

The source string.

Return Value

The string (formatted as template field data).

Related Functions

FmtOpen, FmtGetField

Example

StrToFmt(hFmt,"CV101 Raw Coal Conveyor");
Name=FmtGetField(hFmt,"Name");
! Sets Name to "CV101".

See Also

String Functions