Format string

Syntax

s.format(formatstring ...)
s.formata(formatstring ...)

Parameters

s - str variable.

formatstring - format-control string.

... - arguments. Variables or other values that will replace format fields in formatstring.

The order and type of arguments must match corresponding format fields in formatstring.
Arguments must be of intrinsic types (str, lpstr, int, double, byte, word, long). Don't use OLE Automation types.

Remarks

format creates string that can include values of variables. The formatstring consists of ordinary characters that are copied unchanged, and format fields that are replaced with values of arguments.

formata differs from format only that it writes to the end of s (appends).

Tips

The mostly used format fields: %i for integer numbers (int, byte, word), %s for strings (str, lpstr), %G for double, %I64i for long, %c for a single character, %X for integers in hexadecimal.

To insert this function, can be used the Text dialog from the code toolbar.

out and some other functions also support formatting. Example: int i=5; out "i=%i" i

Example

int i=50
str s="stringvar"
double d=3.1415926535897932384626433832795
str f
f.format("variables: i=%i, s=''%s'', d=%.10G" i s d)
out f ;;variables: i=50, s="stringvar", d=3.141592654