]>
Commit | Line | Data |
---|---|---|
fea681da MK |
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 | |
fea681da MK |
27 | .B #include <monetary.h> |
28 | .sp | |
29 | .BI "ssize_t strfmon(char *" s ", size_t " max ", const char *" format , | |
30 | .B "...);" | |
fea681da | 31 | .SH DESCRIPTION |
63aa9df0 | 32 | The \fBstrfmon\fP() function formats the specified amounts |
fea681da MK |
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. Conversion specifiers are introduced by a `%' | |
38 | character. Immediately following it there can be zero or more | |
39 | of the following flags: | |
40 | .TP | |
41 | .BI = f | |
42 | The single-byte character | |
43 | .I f | |
44 | is used as the numeric fill character (to be used with | |
45 | a left precision, see below). | |
46 | When not specified, the space character is used. | |
47 | .TP | |
48 | .B ^ | |
49 | Do not use any grouping characters that might be defined | |
50 | for the current locale. By default, grouping is enabled. | |
51 | .TP | |
52 | .BR ( " or " + | |
53 | The ( flag indicates that negative amounts should be enclosed between | |
54 | parentheses. The + flag indicates that signs should be handled | |
55 | in the default way, that is, amounts are preceded by the locale's | |
8c383102 | 56 | sign indication, e.g., nothing for positive, "\-" for negative. |
fea681da MK |
57 | .TP |
58 | .BR ! | |
59 | Omit the currency symbol. | |
60 | .TP | |
61 | .BR \- | |
62 | Left justify all fields. The default is right justification. | |
63 | .LP | |
64 | Next, there may be a field width: a decimal digit string specifying | |
65 | a minimum field width in bytes. The default is 0. | |
66 | A result smaller than this width is padded with spaces | |
67 | (on the left, unless the left-justify flag was given). | |
68 | .LP | |
69 | Next, there may be a left precision of the form "#" followed by | |
70 | a decimal digit string. If the number of digits left of the | |
71 | radix character is smaller than this, the representation is | |
72 | padded on the left with the numeric fill character. | |
73 | Grouping characters are not counted in this field width. | |
74 | .LP | |
75 | Next, there may be a right precision of the form "." followed by | |
76 | a decimal digit string. The amount being formatted is rounded to | |
77 | the specified number of digits prior to formatting. | |
78 | The default is specified in the | |
79 | .I frac_digits | |
80 | and | |
81 | .I int_frac_digits | |
82 | items of the current locale. | |
83 | If the right precision is 0, no radix character is printed. | |
84 | (The radix character here is determined by LC_MONETARY, and may | |
85 | differ from that specified by LC_NUMERIC.) | |
86 | .LP | |
87 | Finally, the conversion specification must be ended with a | |
88 | conversion character. The three conversion characters are | |
89 | .TP | |
90 | .B % | |
91 | (In this case the entire specification must be exactly "%%".) | |
92 | Put a `%' character in the result string. | |
93 | .TP | |
94 | .B i | |
95 | One argument of type double is converted using the locale's | |
96 | international currency format. | |
97 | .TP | |
98 | .B n | |
99 | One argument of type double is converted using the locale's | |
100 | national currency format. | |
101 | .SH "RETURN VALUE" | |
63aa9df0 | 102 | The \fBstrfmon\fP() function returns the number of characters placed |
28d88c17 MK |
103 | in the array \fIs\fP, not including the terminating null byte, |
104 | provided the string, including the terminating null byte, fits. | |
fea681da MK |
105 | Otherwise, it sets |
106 | .I errno | |
107 | to E2BIG, returns \-1, and the contents of the array is undefined. | |
108 | .SH EXAMPLE | |
109 | The call | |
110 | .RS | |
111 | .nf | |
b9f02710 | 112 | |
fea681da MK |
113 | strfmon(buf, sizeof(buf), "[%^=*#6n] [%=*#6i]", |
114 | 1234.567, 1234.567); | |
b9f02710 | 115 | |
fea681da MK |
116 | .fi |
117 | .RE | |
118 | outputs | |
119 | .RS | |
b9f02710 | 120 | |
fea681da | 121 | [ fl **1234,57] [ NLG **1 234,57] |
b9f02710 | 122 | |
fea681da MK |
123 | .RE |
124 | in the Dutch locale (with fl for "florijnen" and NLG for Netherlands Guilders). | |
125 | The grouping character is very ugly because it takes as much space | |
126 | as a digit, while it should not take more than half that, | |
127 | and will no doubt cause confusion. | |
128 | Surprisingly, the "fl" is preceded and followed by a space, | |
129 | and "NLG" is preceded by one and followed by two spaces. | |
130 | This may be a bug in the locale files. The Italian, Australian, Swiss | |
131 | and Portuguese locales yield | |
132 | .RS | |
b9f02710 | 133 | |
fea681da MK |
134 | [ L. **1235] [ ITL **1.235] |
135 | .br | |
136 | [ $**1234.57] [ AUD **1,234.57] | |
137 | .br | |
138 | [Fr. **1234,57] [CHF **1.234,57] | |
139 | .br | |
140 | [ **1234$57Esc] [ **1.234$57PTE ] | |
141 | .RE | |
a7fadb55 MK |
142 | .SH "CONFORMING TO" |
143 | Not in POSIX.1-2001. | |
ef0b8171 | 144 | Present on several other systems. |
fea681da MK |
145 | .SH "SEE ALSO" |
146 | .BR setlocale (3), | |
147 | .BR sprintf (3), | |
148 | .BR locale (7) |