stdlib/strfmon.3

   1 .\"     $NetBSD: strfmon.3,v 1.3 2005/04/04 08:19:00 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2001 Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     From: FreeBSD: Id: strfmon.3,v 1.7 2003/01/06 06:21:25 tjr Exp
  28 .\"
  29 .Dd October 12, 2002
  30 .Dt STRFMON 3
  31 .Os
  32 .Sh NAME
  33 .Nm strfmon ,
  34 .Nm strfmon_l
  35 .Nd convert monetary value to string
  36 .\" .Sh LIBRARY
  37 .\" .Lb libc
  38 .Sh SYNOPSIS
  39 .In monetary.h
  40 .Ft ssize_t
  41 .Fo strfmon
  42 .Fa "char *restrict s"
  43 .Fa "size_t maxsize"
  44 .Fa "const char *restrict format"
  45 .Fa "..."
  46 .Fc
  47 .In monetary.h
  48 .In xlocale.h
  49 .Ft ssize_t
  50 .Fo strfmon_l
  51 .Fa "char *restrict s"
  52 .Fa "size_t maxsize"
  53 .Fa "locale_t loc"
  54 .Fa "const char *restrict format"
  55 .Fa "..."
  56 .Fc
  57 .Sh DESCRIPTION
  58 The
  59 .Fn strfmon
  60 function places characters into the array pointed to by
  61 .Fa s ,
  62 as controlled by the string pointed to by
  63 .Fa format .
  64 No more than
  65 .Fa maxsize
  66 bytes are placed into the array.
  67 .Pp
  68 While the
  69 .Fn strfmon
  70 function uses the current locale, the
  71 .Fn strfmon_l
  72 function may be passed a locale directly. See
  73 .Xr xlocale 3
  74 for more information.
  75 .Pp
  76 The format string is composed of zero or more directives:
  77 ordinary characters (not
  78 .Cm % ) ,
  79 which are copied unchanged to the output stream; and conversion
  80 specifications, each of which results in fetching zero or more subsequent
  81 arguments.
  82 Each conversion specification is introduced by the
  83 .Cm %
  84 character.
  85 After the
  86 .Cm % ,
  87 the following appear in sequence:
  88 .Bl -bullet
  89 .It
  90 Zero or more of the following flags:
  91 .Bl -tag -width "XXX"
  92 .It Cm = Ns Ar f
  93 A
  94 .Sq Cm =
  95 character followed by another character
  96 .Ar f
  97 which is used as the numeric fill character.
  98 .It Cm ^
  99 Do not use grouping characters, regardless of the current locale default.
 100 .It Cm +
 101 Represent positive values by prefixing them with a positive sign,
 102 and negative values by prefixing them with a negative sign.
 103 This is the default.
 104 .It Cm \&(
 105 Enclose negative values in parentheses.
 106 .It Cm \&!
 107 Do not include a currency symbol in the output.
 108 .It Cm \-
 109 Left justify the result.
 110 Only valid when a field width is specified.
 111 .El
 112 .It
 113 An optional minimum field width as a decimal number.
 114 By default, there is no minimum width.
 115 .It
 116 A
 117 .Sq Cm #
 118 sign followed by a decimal number specifying the maximum
 119 expected number of digits after the radix character.
 120 .It
 121 A
 122 .Sq Cm \&.
 123 character followed by a decimal number specifying the number
 124 of digits after the radix character.
 125 .It
 126 One of the following conversion specifiers:
 127 .Bl -tag -width "XXX"
 128 .It Cm i
 129 The
 130 .Vt double
 131 argument is formatted as an international monetary amount.
 132 .It Cm n
 133 The
 134 .Vt double
 135 argument is formatted as a national monetary amount.
 136 .It Cm %
 137 A
 138 .Sq Li %
 139 character is written.
 140 .El
 141 .El
 142 .Sh RETURN VALUES
 143 If the total number of resulting bytes, including the terminating
 144 .Dv NULL
 145 byte, is not more than
 146 .Fa maxsize ,
 147 .Fn strfmon
 148 returns the number of bytes placed into the array pointed to by
 149 .Fa s ,
 150 not including the terminating
 151 .Dv NULL
 152 byte.
 153 Otherwise, \-1 is returned,
 154 the contents of the array are indeterminate,
 155 and
 156 .Va errno
 157 is set to indicate the error.
 158 .Sh ERRORS
 159 The
 160 .Fn strfmon
 161 function will fail if:
 162 .Bl -tag -width Er
 163 .It Bq Er E2BIG
 164 Conversion stopped due to lack of space in the buffer.
 165 .It Bq Er EINVAL
 166 The format string is invalid.
 167 .It Bq Er ENOMEM
 168 Not enough memory for temporary buffers.
 169 .El
 170 .Sh EXAMPLE
 171 .Bd -literal -offset indent -compact
 172   #include <stdio.h>
 173   #include <monetary.h>
 174   #include <locale.h>
 175
 176   int main() {
 177           char buf[200];
 178           setlocale(LC_ALL, "en_US");
 179           (void)strfmon (buf, sizeof(buf)-1, "%n" , 123456.78);
 180           printf("%s\n", buf);
 181   }
 182 .Ed
 183 .Pp
 184 .Sh SEE ALSO
 185 .Xr localeconv 3 ,
 186 .Xr xlocale 3
 187 .Sh STANDARDS
 188 The
 189 .Fn strfmon
 190 function
 191 conforms to
 192 .St -p1003.1-2001 .
 193 .Sh AUTHORS
 194 .An -nosplit
 195 The
 196 .Fn strfmon
 197 function was implemented by
 198 .An Alexey Zelkin Aq phantom@FreeBSD.org .
 199 .Pp
 200 This manual page was written by
 201 .An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org
 202 based on the standard's text.
 203 .Sh BUGS
 204 The
 205 .Fn strfmon
 206 function does not correctly handle multibyte characters in the
 207 .Fa format
 208 argument.