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: src/lib/libc/stdlib/strfmon.3,v 1.3 2001/10/01 13:50:03 ru Exp $
  26 .\"
  27 .Dd September 7, 2001
  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 *s" "size_t maxsize" "const char *format" "..."
  39 .Sh DESCRIPTION
  40 The
  41 .Fn strfmon
  42 function places characters into the array pointed to by
  43 .Fa s
  44 as controlled by the string pointed to by
  45 .Fa format .
  46 No more than
  47 .Fa maxsize
  48 bytes are placed into the array.
  49 .Sh RETURN VALUES
  50 If the total number of resulting bytes including the terminating
  51 .Dv NULL
  52 byte is not more than
  53 .Fa maxsize ,
  54 .Fn strfmon
  55 returns the number of bytes placed into the array pointed to by
  56 .Fa s ,
  57 not including the terminating
  58 .Dv NULL
  59 byte.
  60 Otherwise, \-1 is returned,
  61 the contents of the array are indeterminate,
  62 and
  63 .Va errno
  64 is set to indicate the error.
  65 .Sh ERRORS
  66 The
  67 .Fn strfmon
  68 function will fail if:
  69 .Bl -tag -width Er
  70 .It Bq Er E2BIG
  71 Conversion stopped due to lack of space in the buffer.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr localeconv 3
  75 .Sh STANDARDS
  76 The
  77 .Fn strfmon
  78 function
  79 conforms to
  80 .St -xpg4
  81 and
  82 .St -susv2 .
  83 .Sh AUTHORS
  84 .An -nosplit
  85 The
  86 .Fn strfmon
  87 function was implemented by
  88 .An Alexey Zelkin Aq phantom@FreeBSD.org .
  89 .Pp
  90 This manual page was written by
  91 .An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org
  92 based on the standards' text.