1.\" Copyright (c) 2001 Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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. 12.\" 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 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd October 12, 2002 28.Dt STRFMON 3 29.Os 30.Sh NAME 31.Nm strfmon 32.Nd convert monetary value to string 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS 36.In monetary.h 37.Ft ssize_t 38.Fn strfmon "char * restrict s" "size_t maxsize" "const char * restrict format" "..." 39.Sh DESCRIPTION 40The 41.Fn strfmon 42function places characters into the array pointed to by 43.Fa s 44as controlled by the string pointed to by 45.Fa format . 46No more than 47.Fa maxsize 48bytes are placed into the array. 49.Pp 50The format string is composed of zero or more directives: 51ordinary characters (not 52.Cm % ) , 53which are copied unchanged to the output stream; and conversion 54specifications, each of which results in fetching zero or more subsequent 55arguments. 56Each conversion specification is introduced by the 57.Cm % 58character. 59After the 60.Cm % , 61the following appear in sequence: 62.Bl -bullet 63.It 64Zero or more of the following flags: 65.Bl -tag -width "XXX" 66.It Cm = Ns Ar f 67A 68.Sq Cm = 69character followed by another character 70.Ar f 71which is used as the numeric fill character. 72.It Cm ^ 73Do not use grouping characters, regardless of the current locale default. 74.It Cm + 75Represent positive values by prefixing them with a positive sign, 76and negative values by prefixing them with a negative sign. 77This is the default. 78.It Cm \&( 79Enclose negative values in parentheses. 80.It Cm \&! 81Do not include a currency symbol in the output. 82.It Cm \- 83Left justify the result. 84Only valid when a field width is specified. 85.El 86.It 87An optional minimum field width as a decimal number. 88By default, there is no minimum width. 89.It 90A 91.Sq Cm # 92sign followed by a decimal number specifying the maximum 93expected number of digits after the radix character. 94.It 95A 96.Sq Cm \&. 97character followed by a decimal number specifying the number 98the number of digits after the radix character. 99.It 100One of the following conversion specifiers: 101.Bl -tag -width "XXX" 102.It Cm i 103The 104.Vt double 105argument is formatted as an international monetary amount. 106.It Cm n 107The 108.Vt double 109argument is formatted as a national monetary amount. 110.It Cm % 111A 112.Sq Li % 113character is written. 114.El 115.El 116.Sh RETURN VALUES 117If the total number of resulting bytes including the terminating 118.Dv NULL 119byte is not more than 120.Fa maxsize , 121.Fn strfmon 122returns the number of bytes placed into the array pointed to by 123.Fa s , 124not including the terminating 125.Dv NULL 126byte. 127Otherwise, \-1 is returned, 128the contents of the array are indeterminate, 129and 130.Va errno 131is set to indicate the error. 132.Sh ERRORS 133The 134.Fn strfmon 135function will fail if: 136.Bl -tag -width Er 137.It Bq Er E2BIG 138Conversion stopped due to lack of space in the buffer. 139.It Bq Er EINVAL 140The format string is invalid. 141.It Bq Er ENOMEM 142Not enough memory for temporary buffers. 143.El 144.Sh SEE ALSO 145.Xr localeconv 3 146.Sh STANDARDS 147The 148.Fn strfmon 149function 150conforms to 151.St -p1003.1-2001 . 152.Sh AUTHORS 153.An -nosplit 154The 155.Fn strfmon 156function was implemented by 157.An Alexey Zelkin Aq phantom@FreeBSD.org . 158.Pp 159This manual page was written by 160.An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org 161based on the standards' text. 162.Sh BUGS 163The 164.Fn strfmon 165function does not correctly handle multibyte characters in the 166.Fa format 167argument. 168