xref: /freebsd-12.1/lib/libc/stdlib/strfmon.3 (revision 8c9893a3)
1.\" Copyright (c) 2001 Jeroen Ruigrok van der Werven <[email protected]>
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 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.Fd #include <monetary.h>
37.Ft ssize_t
38.Fn strfmon "char *s" "size_t maxsize" "const char *format" "..."
39.Sh DESCRIPTION
40The
41.Fn strfmon
42function places characters into the array pointed to by
43.Fa s
44as controlled by the strong pointed to by
45.Fa format .
46No more than
47.Fa maxsize
48bytes are placed into the array.
49.Sh RETURN VALUES
50If the total number of resulting bytes including the terminating null
51byte is not more than
52.Fa maxsize ,
53.Nm
54returns the number of bytes placed into the array pointed to by
55.Fa s ,
56not including the terminating null byte.
57Otherwise, -1 is returned,
58the contents of the array are indeterminate,
59and
60.Va errno
61is set to indicate the error.
62.Sh ERRORS
63The
64.Nm
65function will fail if:
66.Bl -tag -width Er
67.It Bq Er E2BIG
68Conversion stopped due to lack of space in the buffer.
69.El
70.Sh SEE ALSO
71.Xr localeconv 3
72.Sh STANDARDS
73The
74.Fn strfmon
75function
76conforms to
77.St -xpg4
78and
79.St -susv2
80.Sh AUTHORS
81The
82.Nm
83function was implemented by
84.An Alexey Zelkin Aq [email protected] .
85.Pp
86This manual page was written by
87.An Jeroen Ruigrok van der Werven Aq [email protected]
88based on the standards' text.
89