1 .\" Copyright (c) 2001 Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .Nd convert monetary value to string
39 .Fn strfmon "char * restrict s" "size_t maxsize" "const char * restrict format" "..."
43 .Fn strfmon_l "char * restrict s" "size_t maxsize" "locale_t loc" "const char * restrict format" "..."
47 function places characters into the array pointed to by
49 as controlled by the string pointed to by
53 bytes are placed into the array.
57 function takes an explicit locale argument, whereas the
59 function uses the current global or per-thread locale.
61 The format string is composed of zero or more directives:
62 ordinary characters (not
64 which are copied unchanged to the output stream; and conversion
65 specifications, each of which results in fetching zero or more subsequent
67 Each conversion specification is introduced by the
72 the following appear in sequence:
75 Zero or more of the following flags:
80 character followed by another character
82 which is used as the numeric fill character.
84 Do not use grouping characters, regardless of the current locale default.
86 Represent positive values by prefixing them with a positive sign,
87 and negative values by prefixing them with a negative sign.
90 Enclose negative values in parentheses.
92 Do not include a currency symbol in the output.
94 Left justify the result.
95 Only valid when a field width is specified.
98 An optional minimum field width as a decimal number.
99 By default, there is no minimum width.
103 sign followed by a decimal number specifying the maximum
104 expected number of digits before the radix character.
105 When this option is used, values that do not exceed the
106 specified number of digits are formatted so they will be
107 correctly aligned with other values printed using the same
109 This includes always leaving space for a possible sign
110 indicator, even if none is needed for a particular value.
114 character followed by a decimal number specifying the number
115 of digits after the radix character.
117 One of the following conversion specifiers:
118 .Bl -tag -width "XXX"
122 argument is formatted as an international monetary amount.
126 argument is formatted as a national monetary amount.
130 character is written.
134 If the total number of resulting bytes, including the terminating
136 byte, is not more than
141 return the number of bytes placed into the array pointed to by
143 not including the terminating
146 Otherwise, \-1 is returned,
147 the contents of the array are indeterminate,
150 is set to indicate the error.
152 The following example will format the value
155 .Dq Li $1,234,567.89 :
156 .Bd -literal -offset indent
158 #include <monetary.h>
165 double money = 1234567.89;
167 if (setlocale(LC_MONETARY, "en_US.UTF-8") == NULL) {
168 fprintf(stderr, "Unable to setlocale().\\n");
172 strfmon(string, sizeof(string) - 1, "%n", money);
173 printf("%s\\n", string);
179 function will fail if:
182 Conversion stopped due to lack of space in the buffer.
184 The format string is invalid.
186 Not enough memory for temporary buffers.
205 function was implemented by
206 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
208 This manual page was written by
209 .An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org
210 based on the standards' text.
214 function does not correctly handle multibyte characters in the