2001-09-07 09:55:28 +00:00
|
|
|
.\" Copyright (c) 2001 Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org>
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
2022-11-08 20:53:17 +00:00
|
|
|
.Dd January 25, 2023
|
2001-09-07 09:55:28 +00:00
|
|
|
.Dt STRFMON 3
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
2022-10-28 08:29:16 +00:00
|
|
|
.Nm strfmon ,
|
|
|
|
.Nm strfmon_l
|
2001-09-07 09:55:28 +00:00
|
|
|
.Nd convert monetary value to string
|
|
|
|
.Sh LIBRARY
|
|
|
|
.Lb libc
|
|
|
|
.Sh SYNOPSIS
|
2001-09-07 12:38:10 +00:00
|
|
|
.In monetary.h
|
2001-09-07 09:55:28 +00:00
|
|
|
.Ft ssize_t
|
2002-09-20 08:24:01 +00:00
|
|
|
.Fn strfmon "char * restrict s" "size_t maxsize" "const char * restrict format" "..."
|
2022-11-08 20:53:17 +00:00
|
|
|
.In monetary.h
|
|
|
|
.In xlocale.h
|
2012-06-25 21:51:40 +00:00
|
|
|
.Ft ssize_t
|
|
|
|
.Fn strfmon_l "char * restrict s" "size_t maxsize" "locale_t loc" "const char * restrict format" "..."
|
2001-09-07 09:55:28 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Fn strfmon
|
|
|
|
function places characters into the array pointed to by
|
2022-11-08 20:53:17 +00:00
|
|
|
.Fa s ,
|
2001-09-07 12:38:10 +00:00
|
|
|
as controlled by the string pointed to by
|
2001-09-07 09:55:28 +00:00
|
|
|
.Fa format .
|
|
|
|
No more than
|
|
|
|
.Fa maxsize
|
|
|
|
bytes are placed into the array.
|
2002-10-11 23:17:17 +00:00
|
|
|
.Pp
|
2012-06-25 21:51:40 +00:00
|
|
|
The
|
|
|
|
.Fn strfmon_l
|
2022-11-08 20:53:17 +00:00
|
|
|
function takes an explicit locale argument, whereas the
|
2012-06-25 21:51:40 +00:00
|
|
|
.Fn strfmon
|
2022-11-08 20:53:17 +00:00
|
|
|
function uses the current global or per-thread locale.
|
2012-06-25 21:51:40 +00:00
|
|
|
.Pp
|
2002-10-11 23:17:17 +00:00
|
|
|
The format string is composed of zero or more directives:
|
|
|
|
ordinary characters (not
|
2002-11-29 15:57:50 +00:00
|
|
|
.Cm % ) ,
|
2002-10-11 23:17:17 +00:00
|
|
|
which are copied unchanged to the output stream; and conversion
|
|
|
|
specifications, each of which results in fetching zero or more subsequent
|
|
|
|
arguments.
|
|
|
|
Each conversion specification is introduced by the
|
|
|
|
.Cm %
|
|
|
|
character.
|
|
|
|
After the
|
|
|
|
.Cm % ,
|
|
|
|
the following appear in sequence:
|
|
|
|
.Bl -bullet
|
|
|
|
.It
|
|
|
|
Zero or more of the following flags:
|
|
|
|
.Bl -tag -width "XXX"
|
|
|
|
.It Cm = Ns Ar f
|
|
|
|
A
|
|
|
|
.Sq Cm =
|
|
|
|
character followed by another character
|
|
|
|
.Ar f
|
|
|
|
which is used as the numeric fill character.
|
|
|
|
.It Cm ^
|
|
|
|
Do not use grouping characters, regardless of the current locale default.
|
|
|
|
.It Cm +
|
|
|
|
Represent positive values by prefixing them with a positive sign,
|
|
|
|
and negative values by prefixing them with a negative sign.
|
|
|
|
This is the default.
|
2002-11-29 15:57:50 +00:00
|
|
|
.It Cm \&(
|
2002-10-11 23:17:17 +00:00
|
|
|
Enclose negative values in parentheses.
|
2002-11-29 15:57:50 +00:00
|
|
|
.It Cm \&!
|
2002-10-11 23:17:17 +00:00
|
|
|
Do not include a currency symbol in the output.
|
|
|
|
.It Cm \-
|
|
|
|
Left justify the result.
|
|
|
|
Only valid when a field width is specified.
|
|
|
|
.El
|
|
|
|
.It
|
|
|
|
An optional minimum field width as a decimal number.
|
|
|
|
By default, there is no minimum width.
|
|
|
|
.It
|
|
|
|
A
|
|
|
|
.Sq Cm #
|
|
|
|
sign followed by a decimal number specifying the maximum
|
2022-10-13 16:11:31 +00:00
|
|
|
expected number of digits before the radix character.
|
|
|
|
When this option is used, values that do not exceed the
|
|
|
|
specified number of digits are formatted so they will be
|
|
|
|
correctly aligned with other values printed using the same
|
|
|
|
format.
|
|
|
|
This includes always leaving space for a possible sign
|
|
|
|
indicator, even if none is needed for a particular value.
|
2002-10-11 23:17:17 +00:00
|
|
|
.It
|
|
|
|
A
|
|
|
|
.Sq Cm \&.
|
|
|
|
character followed by a decimal number specifying the number
|
2022-10-13 16:22:54 +00:00
|
|
|
of digits after the radix character.
|
2002-10-11 23:17:17 +00:00
|
|
|
.It
|
|
|
|
One of the following conversion specifiers:
|
|
|
|
.Bl -tag -width "XXX"
|
|
|
|
.It Cm i
|
|
|
|
The
|
|
|
|
.Vt double
|
|
|
|
argument is formatted as an international monetary amount.
|
|
|
|
.It Cm n
|
|
|
|
The
|
|
|
|
.Vt double
|
|
|
|
argument is formatted as a national monetary amount.
|
|
|
|
.It Cm %
|
|
|
|
A
|
|
|
|
.Sq Li %
|
|
|
|
character is written.
|
|
|
|
.El
|
|
|
|
.El
|
2001-09-07 09:55:28 +00:00
|
|
|
.Sh RETURN VALUES
|
2022-11-08 20:53:17 +00:00
|
|
|
If the total number of resulting bytes, including the terminating
|
2012-05-11 20:06:46 +00:00
|
|
|
.Dv NUL
|
2022-11-08 20:53:17 +00:00
|
|
|
byte, is not more than
|
2001-09-07 09:55:28 +00:00
|
|
|
.Fa maxsize ,
|
2001-09-07 12:38:10 +00:00
|
|
|
.Fn strfmon
|
2022-11-08 20:53:17 +00:00
|
|
|
and
|
|
|
|
.Fn strfmon_l
|
|
|
|
return the number of bytes placed into the array pointed to by
|
2001-09-07 09:55:28 +00:00
|
|
|
.Fa s ,
|
2001-09-07 12:38:10 +00:00
|
|
|
not including the terminating
|
2012-05-11 20:06:46 +00:00
|
|
|
.Dv NUL
|
2001-09-07 12:38:10 +00:00
|
|
|
byte.
|
2002-11-29 15:57:50 +00:00
|
|
|
Otherwise, \-1 is returned,
|
2001-09-07 09:55:28 +00:00
|
|
|
the contents of the array are indeterminate,
|
|
|
|
and
|
|
|
|
.Va errno
|
|
|
|
is set to indicate the error.
|
2022-11-08 20:36:57 +00:00
|
|
|
.Sh EXAMPLES
|
|
|
|
The following example will format the value
|
|
|
|
.Dq Li 1234567.89
|
|
|
|
to the string
|
|
|
|
.Dq Li $1,234,567.89 :
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <monetary.h>
|
|
|
|
#include <xlocale.h>
|
|
|
|
|
|
|
|
int
|
|
|
|
main()
|
|
|
|
{
|
|
|
|
char string[100];
|
|
|
|
double money = 1234567.89;
|
|
|
|
|
|
|
|
if (setlocale(LC_MONETARY, "en_US.UTF-8") == NULL) {
|
|
|
|
fprintf(stderr, "Unable to setlocale().\\n");
|
|
|
|
return (1);
|
|
|
|
}
|
|
|
|
|
|
|
|
strfmon(string, sizeof(string) - 1, "%n", money);
|
|
|
|
printf("%s\\n", string);
|
|
|
|
}
|
|
|
|
.Ed
|
2001-09-07 09:55:28 +00:00
|
|
|
.Sh ERRORS
|
|
|
|
The
|
2001-09-07 12:38:10 +00:00
|
|
|
.Fn strfmon
|
2001-09-07 09:55:28 +00:00
|
|
|
function will fail if:
|
|
|
|
.Bl -tag -width Er
|
|
|
|
.It Bq Er E2BIG
|
|
|
|
Conversion stopped due to lack of space in the buffer.
|
2002-10-11 23:17:17 +00:00
|
|
|
.It Bq Er EINVAL
|
|
|
|
The format string is invalid.
|
|
|
|
.It Bq Er ENOMEM
|
|
|
|
Not enough memory for temporary buffers.
|
2001-09-07 09:55:28 +00:00
|
|
|
.El
|
|
|
|
.Sh SEE ALSO
|
2022-10-28 08:29:16 +00:00
|
|
|
.Xr localeconv 3 ,
|
|
|
|
.Xr xlocale 3
|
2001-09-07 09:55:28 +00:00
|
|
|
.Sh STANDARDS
|
|
|
|
The
|
|
|
|
.Fn strfmon
|
|
|
|
function
|
|
|
|
conforms to
|
2002-10-11 23:17:17 +00:00
|
|
|
.St -p1003.1-2001 .
|
2012-06-25 21:51:40 +00:00
|
|
|
The
|
|
|
|
.Fn strfmon_l
|
|
|
|
function conforms to
|
|
|
|
.St -p1003.1-2008 .
|
2001-09-07 09:55:28 +00:00
|
|
|
.Sh AUTHORS
|
2001-10-01 13:50:03 +00:00
|
|
|
.An -nosplit
|
2001-09-07 09:55:28 +00:00
|
|
|
The
|
2001-09-07 12:38:10 +00:00
|
|
|
.Fn strfmon
|
2001-09-07 09:55:28 +00:00
|
|
|
function was implemented by
|
2014-06-23 08:25:03 +00:00
|
|
|
.An Alexey Zelkin Aq Mt phantom@FreeBSD.org .
|
2001-09-07 09:55:28 +00:00
|
|
|
.Pp
|
|
|
|
This manual page was written by
|
2014-06-23 08:25:03 +00:00
|
|
|
.An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org
|
2001-09-07 09:55:28 +00:00
|
|
|
based on the standards' text.
|
2003-01-06 06:21:25 +00:00
|
|
|
.Sh BUGS
|
|
|
|
The
|
|
|
|
.Fn strfmon
|
|
|
|
function does not correctly handle multibyte characters in the
|
|
|
|
.Fa format
|
|
|
|
argument.
|