lib/libc/stdlib/strfmon.3

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