Seth Woolley's Man Viewer

strfmon(3) - strfmon, strfmon - convert monetary value to a string - man 3 strfmon

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

STRFMON(3)                 Linux Programmer's Manual                STRFMON(3)



NAME
       strfmon - convert monetary value to a string(3,n)

SYNOPSIS
       #include <monetary.h>

       ssize_t strfmon(char *s, size_t max, const char *format,
       ...);

DESCRIPTION
       The  strfmon()  function formats the specified amounts according to the
       format specification format and places  the  result  in(1,8)  the  character
       array s of size max.

       Ordinary characters in(1,8) format are copied to s without conversion.  Con-
       version(1,3,5) specifiers are introduced by a `%' character. Immediately  fol-
       lowing it there can be zero or more of the following flags:

       =f     The  single-byte character f is used as the numeric fill charac-
              ter (to be used with a left precision,  see  below).   When  not
              specified, the space character is used.

       ^      Do not use any grouping characters that might be defined for the
              current locale. By default, grouping is enabled.

       ( or + The ( flag indicates that negative amounts  should  be  enclosed
              between  parentheses.  The + flag indicates that signs should be
              handled in(1,8) the default way, that is, amounts are preceded by the
              locale(3,5,7)'s  sign  indication,  e.g., nothing for positive, "-" for
              negative.

       !      Omit the currency symbol.

       -      Left justify all fields. The default is right justification.

       Next, there may be a field width: a decimal digit string(3,n)  specifying  a
       minimum  field width in(1,8) bytes. The default is 0.  A result smaller than
       this width is padded with spaces (on the left, unless the  left-justify
       flag was given).

       Next, there may be a left precision of the form "#" followed by a deci-
       mal digit string. If the number of digits left of the  radix  character
       is smaller than this, the representation is padded on the left with the
       numeric fill character.  Grouping characters are not  counted  in(1,8)  this
       field width.

       Next, there may be a right precision of the form "." followed by a dec-
       imal digit string. The amount being formatted is rounded to the  speci-
       fied number of digits prior to formatting.  The default is specified in(1,8)
       the frac_digits and int_frac_digits items of the  current  locale.   If
       the  right  precision  is 0, no radix character is printed.  (The radix
       character here is determined by LC_MONETARY, and may differ  from  that
       specified by LC_NUMERIC.)

       Finally,  the  conversion specification must be ended with a conversion
       character. The three conversion characters are

       %      (In this case the entire specification must  be  exactly  "%%".)
              Put a `%' character in(1,8) the result string.

       i      One  argument  of  type  double  is converted using the locale(3,5,7)'s
              international currency format.

       n      One argument of type double  is  converted  using  the  locale(3,5,7)'s
              national currency format.

RETURN VALUE
       The  strfmon()  function returns the number of characters placed in(1,8) the
       array s, not including the  terminating  NUL  character,  provided  the
       string(3,n),  including the terminating NUL, fits.  Otherwise, it sets errno
       to E2BIG, returns -1, and the contents of the array is undefined.

EXAMPLE
       The call
              strfmon(buf, sizeof(buf), "[%^=*#6n] [%=*#6i]",
                      1234.567, 1234.567);
       outputs
              [ fl **1234,57] [ NLG  **1 234,57]
       in(1,8) the Dutch locale(3,5,7) (with fl for "florijnen" and  NLG  for  Netherlands
       Guilders).   The  grouping  character  is very ugly because it takes as
       much space as a digit, while it should not take more  than  half  that,
       and  will no doubt cause confusion.  Surprisingly, the "fl" is preceded
       and followed by a space, and "NLG" is preceded by one and  followed  by
       two  spaces.   This may be a bug in(1,8) the locale(3,5,7) files. The Italian, Aus-
       tralian, Swiss and Portuguese locales yield
              [ L. **1235] [ ITL  **1.235]
              [ $**1234.57] [ AUD **1,234.57]
              [Fr. **1234,57] [CHF  **1.234,57]
              [ **1234$57Esc] [ **1.234$57PTE ]

SEE ALSO
       setlocale(3), sprintf(3), locale(3,5,7)(7)



Linux                             2000-12-05                        STRFMON(3)

References for this manual (incoming links)