man3/strfmon.3

   1 .\" Copyright (c) 2000 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  21 .\" USA.
  22 .\"
  23 .TH STRFMON 3  2000-12-05 "Linux" "Linux Programmer's Manual"
  24 .SH NAME
  25 strfmon \- convert monetary value to a string
  26 .SH SYNOPSIS
  27 .B #include <monetary.h>
  28 .sp
  29 .BI "ssize_t strfmon(char *" s ", size_t " max ", const char *" format ,
  30 .B "...);"
  31 .SH DESCRIPTION
  32 The \fBstrfmon\fP() function formats the specified amounts
  33 according to the format specification \fIformat\fP and places the
  34 result in the character array \fIs\fP of size \fImax\fP.
  35 .PP
  36 Ordinary characters in \fIformat\fP are copied to \fIs\fP
  37 without conversion.
  38 Conversion specifiers are introduced by a `%'
  39 character.
  40 Immediately following it there can be zero or more
  41 of the following flags:
  42 .TP
  43 .BI = f
  44 The single-byte character
  45 .I f
  46 is used as the numeric fill character (to be used with
  47 a left precision, see below).
  48 When not specified, the space character is used.
  49 .TP
  50 .B ^
  51 Do not use any grouping characters that might be defined
  52 for the current locale.
  53 By default, grouping is enabled.
  54 .TP
  55 .BR ( " or " +
  56 The ( flag indicates that negative amounts should be enclosed between
  57 parentheses.
  58 The + flag indicates that signs should be handled
  59 in the default way, that is, amounts are preceded by the locale's
  60 sign indication, e.g., nothing for positive, "\-" for negative.
  61 .TP
  62 .BR !
  63 Omit the currency symbol.
  64 .TP
  65 .BR \-
  66 Left justify all fields.
  67 The default is right justification.
  68 .LP
  69 Next, there may be a field width: a decimal digit string specifying
  70 a minimum field width in bytes.
  71 The default is 0.
  72 A result smaller than this width is padded with spaces
  73 (on the left, unless the left-justify flag was given).
  74 .LP
  75 Next, there may be a left precision of the form "#" followed by
  76 a decimal digit string.
  77 If the number of digits left of the
  78 radix character is smaller than this, the representation is
  79 padded on the left with the numeric fill character.
  80 Grouping characters are not counted in this field width.
  81 .LP
  82 Next, there may be a right precision of the form "." followed by
  83 a decimal digit string.
  84 The amount being formatted is rounded to
  85 the specified number of digits prior to formatting.
  86 The default is specified in the
  87 .I frac_digits
  88 and
  89 .I int_frac_digits
  90 items of the current locale.
  91 If the right precision is 0, no radix character is printed.
  92 (The radix character here is determined by LC_MONETARY, and may
  93 differ from that specified by LC_NUMERIC.)
  94 .LP
  95 Finally, the conversion specification must be ended with a
  96 conversion character.
  97 The three conversion characters are
  98 .TP
  99 .B %
 100 (In this case the entire specification must be exactly "%%".)
 101 Put a `%' character in the result string.
 102 .TP
 103 .B i
 104 One argument of type double is converted using the locale's
 105 international currency format.
 106 .TP
 107 .B n
 108 One argument of type double is converted using the locale's
 109 national currency format.
 110 .SH "RETURN VALUE"
 111 The \fBstrfmon\fP() function returns the number of characters placed
 112 in the array \fIs\fP, not including the terminating null byte,
 113 provided the string, including the terminating null byte, fits.
 114 Otherwise, it sets
 115 .I errno
 116 to E2BIG, returns \-1, and the contents of the array is undefined.
 117 .SH EXAMPLE
 118 The call
 119 .RS
 120 .nf
 121
 122 strfmon(buf, sizeof(buf), "[%^=*#6n] [%=*#6i]",
 123         1234.567, 1234.567);
 124
 125 .fi
 126 .RE
 127 outputs
 128 .RS
 129
 130 [ fl **1234,57] [ NLG  **1 234,57]
 131
 132 .RE
 133 in the Dutch locale (with fl for "florijnen" and NLG for Netherlands Guilders).
 134 The grouping character is very ugly because it takes as much space
 135 as a digit, while it should not take more than half that,
 136 and will no doubt cause confusion.
 137 Surprisingly, the "fl" is preceded and followed by a space,
 138 and "NLG" is preceded by one and followed by two spaces.
 139 This may be a bug in the locale files.
 140 The Italian, Australian, Swiss
 141 and Portuguese locales yield
 142 .RS
 143
 144 [ L. **1235] [ ITL  **1.235]
 145 .br
 146 [ $**1234.57] [ AUD **1,234.57]
 147 .br
 148 [Fr. **1234,57] [CHF  **1.234,57]
 149 .br
 150 [ **1234$57Esc] [ **1.234$57PTE ]
 151 .RE
 152 .SH "CONFORMING TO"
 153 Not in POSIX.1-2001.
 154 Present on several other systems.
 155 .SH "SEE ALSO"
 156 .BR setlocale (3),
 157 .BR sprintf (3),
 158 .BR locale (7)