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
25 .\" $FreeBSD: src/lib/libc/stdlib/strfmon.3,v 1.7 2003/01/06 06:21:25 tjr Exp $
26 .\" $NetBSD: strfmon.3,v 1.3 2005/04/04 08:19:00 wiz Exp $
33 .Nd convert monetary value to string
39 .Fn strfmon "char * restrict s" "size_t maxsize" "const char * restrict format" "..."
43 function places characters into the array pointed to by
45 as controlled by the string pointed to by
49 bytes are placed into the array.
51 The format string is composed of zero or more directives:
52 ordinary characters (not
54 which are copied unchanged to the output stream; and conversion
55 specifications, each of which results in fetching zero or more subsequent
57 Each conversion specification is introduced by the
62 the following appear in sequence:
65 Zero or more of the following flags:
70 character followed by another character
72 which is used as the numeric fill character.
74 Do not use grouping characters, regardless of the current locale default.
76 Represent positive values by prefixing them with a positive sign,
77 and negative values by prefixing them with a negative sign.
80 Enclose negative values in parentheses.
82 Do not include a currency symbol in the output.
84 Left justify the result.
85 Only valid when a field width is specified.
88 An optional minimum field width as a decimal number.
89 By default, there is no minimum width.
93 sign followed by a decimal number specifying the maximum
94 expected number of digits after the radix character.
98 character followed by a decimal number specifying the number
99 of digits after the radix character.
101 One of the following conversion specifiers:
102 .Bl -tag -width "XXX"
106 argument is formatted as an international monetary amount.
110 argument is formatted as a national monetary amount.
114 character is written.
118 If the total number of resulting bytes including the terminating
120 byte is not more than
123 returns the number of bytes placed into the array pointed to by
125 not including the terminating
128 Otherwise, \-1 is returned,
129 the contents of the array are indeterminate,
132 is set to indicate the error.
136 function will fail if:
139 Conversion stopped due to lack of space in the buffer.
141 The format string is invalid.
143 Not enough memory for temporary buffers.
157 function was implemented by
158 .An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
160 This manual page was written by
161 .An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org
162 based on the standard's text.
166 function does not correctly handle multibyte characters in the