Applies a Word format to the requested value.
The format must be compatible (date format if the value is a date/time/timestamp, numeric if the value is numeric).
This function can be used, for instance, to correctly pre-calculate the text associated with a calculation field in an array.
Parameters
NUM_BIN_4 |
docHandle |
Document handle. |
ALPHA(n) |
value |
Value to be formatted represented in string form. |
ALPHA(n) |
format |
Word format (e.g. \# #.######### for a numeric value). If the format is a date format (\@ xxx), the value is interpreted as a date in *ISO format, like those from &DATE_TO_ALPHA, &TIME_TO_ALPHA, &TMSTP_TO_ALPHA functions. If the format is numeric (\# xxx), the value is interpreted as a numeric constant ([-]figures[.figures]). |
ALPHA(n) |
result |
Formatted value. Output parameter. |
NUM_BIN_4 |
resultLength |
Result variable length. |
NUM_BIN_4 |
rc |
Function return code (see Error codes constants). Output parameter. |
