• Prev
• Next
• Manual/Function

STRFORM†

Format†

STRFORM( format [ , arg ... ] )

Function†

• Returns a formatted string.
• It is the equivalent of sprintf in the C language.

Arguments†

format

Format string.

arg

Format string argument.

Return value†

• If successful, the formatted string
• The behavior if unsuccessful is undefined.

Related†

Version†

• YAYA: Available from the start
• Available in AYA5.8

Example†

The following is a comparison with sprintf. It can be used exactly the same way, except that the result is obtained as a return value, and the prefix character for formatting is $.

// C language
int year = 1941;
char *warname = "pacific";
sprintf(str, "%04d - outbreak of the %s war.", year, warname);

// AYA
year = 1941
warname = "pacific"
str = STRFORM("$04d - outbreak of the $s war.", year, warname)

The length of a string that can be expanded per format specification is limited to 1024 characters.

• Prev
  Manual/Function/STRENCODE
• Next
  Manual/Function/STRLEN
• Home
  Up