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