strfmon(3C) strfmon(3C)
NAME
strfmon - convert monetary value to string
SYNOPSIS
#include <monetary.h>
ssizet strfmon(char *s, sizet maxsize, const char *format, ...);
DESCRIPTION
The strfmon() function places characters into the array pointed to by
s as controlled by the string pointed to by format. No more than max-
size bytes are placed into the array.
The format is a character string that contains two types of objects:
plain characters, which are simply copied to the output stream, and
conversion specifications, each of which results in the fetching of
zero or more arguments which are converted and formatted. The results
are undefined if there are insufficient arguments for the format. If
the format is exhausted while arguments remain, the excess arguments
are simply ignored.
A conversion specification consists of the following sequence:
- a % character
- optional flags
- optional field width
- optional left precision
- optional right precision
- a required conversion character that determines the conversion to
be performed.
Flags
One or more of the following optional flags can be specified to con-
trol the conversion:
=f An = followed by a single character f which is used as the
numeric fill character. The fill character must be representable
in a single byte in order to work with precision and width
counts. The default numeric fill character is the space charac-
ter. This flag does not affect field width filling which always
uses the space character. This flag is ignored unless a left pre-
cision (see below) is specified.
^ Do not format the currency amount with grouping characters. The
default is to insert the grouping characters if defined for the
current locale.
Page 1 Reliant UNIX 5.44 Printed 11/98
strfmon(3C) strfmon(3C)
+ or (
Specify the style of representing positive and negative currency
amounts. Only one of + or ( may be specified. If + is specified,
the locales equivalent of + and - are used (for example, in the
USA: the empty string if positive and - if negative). If ( is
specified, negative amounts are enclosed within parentheses. If
neither flag is specified, the + style is used.
! Suppress the currency symbol from the output conversion.
- Specify the alignment. If this flag is present all fields are
left-justified (padded to the right) rather then right-justified.
Field Width
w A decimal digit string w specifying a minimum field width in bytes
in which the result of the conversion is right-justified (or left-
justified if the flag - is specified). The default is zero.
Left Precision
#n A # followed by a decimal digit string n specifying a maximum
number of digits expected to be formatted to the left of the
radix character. This option can be used to keep the formatted
output from multiple calls to the strfmon() aligned in the same
columns. It can also be used to fill unused positions with a spe-
cial character as in $***123.45. This option causes an amount to
be formatted as if it has the number of digits specified by n. If
more than n digit positions are required, this conversion speci-
fication is ignored. Digit positions in excess of those actually
required are filled within the numeric fill character (see the =f
flag above).
If grouping has not been suppressed with the ^ flag, and it is
defined for the current locale, grouping separators are inserted
before the fill characters (if any) are added. Grouping separa-
tors are not applied to fill characters even if the fill charac-
ter is a digit.
To ensure alignment, any characters appearing before or after the
number in the formatted output such as currency or sign symbols
are padded as necessary with space characters to make their posi-
tive and negative formats an equal length.
Right Precision
.p A period followed by a decimal digit string p specifying the
number of digits after the radix character. If the value of the
right precision p is zero, no radix character appears. If a right
precision is not included, a default specified by the current
locale is used. The amount being formatted is rounded to the
specified number of digits prior to the formatting.
Page 2 Reliant UNIX 5.44 Printed 11/98
strfmon(3C) strfmon(3C)
Conversion Characters
The conversion characters and their meanings are:
i The double argument is formatted according to the locales inter-
national currency format (for example, in the USA: USD 1,234.56).
n The double argument is formatted according to the locales
national currency format (for example, in the USA: $1,234.56).
% Convert to a %; no argument is converted. The entire conversion
specification must be %%.
Locale Information
The LCMONETARY category of the program's locale effects the behavior
of this function including the monetary radix character (which may be
different from the numeric radix character affected by the LCNUMERIC
category), the grouping separator, the currency symbols and formats.
The international currency symbol should be compliant with the ISO
4217:1987 standard.
The strfmon() function will fail if:
ENOSYS The function is not supported.
E2BIG Conversion stopped due to lack of space in the buffer.
Page 3 Reliant UNIX 5.44 Printed 11/98
strfmon(3C) strfmon(3C)
EXAMPLES
Given a locale for the USA and the values 123.45, -123.45 and
3456.781:
______________________________________________________________________
| Conversion | Output | Comments |
| Specification | | |
|_______________|___________________|_________________________________|
| %n | $123.45 | default formatting |
| | -$123.45 | |
| | $ 3,456.78 | |
|_______________|___________________|_________________________________|
| %11n | $123.45 | right align within an 11 char- |
| | -$123.45 | acter field |
| | $ 3,456.78 | |
|_______________|___________________|_________________________________|
| %#5n | $123.45 | aligned columns for values up |
| | -$ 123.45 | to 99,999 |
| | $ 3,456.78 | |
|_______________|___________________|_________________________________|
| %=*#5n | $***123.45 | specify a fill character |
| | -$***123.45 | |
| | $*3,456.78 | |
|_______________|___________________|_________________________________|
| %=0#5n | $000123.45 | fill characters do not use |
| | -$000123.45 | grouping even if the fill char-|
| | $03, 456.78 | acter is a digit |
|_______________|___________________|_________________________________|
| %^#5n | $ 123.45 | disable the grouping separator |
| | - $ 123.45 | |
| | $ 3456.78 | |
|_______________|___________________|_________________________________|
| %^#5.0n | $ 123 | round off the whole units |
| | -$ 123 | |
| | $ 3457 | |
|_______________|___________________|_________________________________|
| %^#5.4n | $ 123.4500| increase the precision |
| | -$ 123.4500| |
| | $ 3456.7810| |
|_______________|___________________|_________________________________|
| %(#5n | 123.45 | use an alternative pos/neg |
| | ($ 123.45) | style |
| | $ 3,456.78 | |
| l |l |l. | | |
|_______________|___________________|_________________________________|
| %!(#5n | 123.45 | disable the currency symbol |
| | ( 123.45) | |
| | 3,456.78 | |
|_______________|___________________|_________________________________|
Page 4 Reliant UNIX 5.44 Printed 11/98
strfmon(3C) strfmon(3C)
RESULT
If the total number of resulting bytes including the terminating null
byte is not more than maxsize, the strfmon() function returns the
number of bytes placed into the array pointed to by s, not including
the terminating null byte. Otherwise, -1 is returned, the contents of
the array are indeterminate, and errno is set to indicate the error.
SEE ALSO
localeconv(3C).
Page 5 Reliant UNIX 5.44 Printed 11/98