xref: /freebsd/lib/libc/stdio/printf_l.3 (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1.\" Copyright (c) 2012 Isabell Long <issyl0@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 AUTHOR 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 AUTHOR 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.Dd April 7, 2012
26.Dt PRINTF_L 3
27.Os
28.Sh NAME
29.Nm printf_l ,
30.Nm asprintf_l ,
31.Nm fprintf_l ,
32.Nm snprintf_l ,
33.Nm sprintf_l ,
34.Nm vasprintf_l ,
35.Nm vfprintf_l ,
36.Nm vprintf_l ,
37.Nm vsnprintf_l ,
38.Nm vsprintf_l
39.Nd formatted output conversion
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In stdio.h
44.In xlocale.h
45.Ft int
46.Fn printf_l "locale_t loc" "const char * restrict format" "..."
47.Ft int
48.Fn asprintf_l "char **ret" "locale_t loc" "const char * format" "..."
49.Ft int
50.Fn fprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "..."
51.Ft int
52.Fn snprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "..."
53.Ft int
54.Fn sprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "..."
55.Ft int
56.Fn vasprintf_l "char **ret" "locale_t loc" "const char *format" "va_list ap"
57.Ft int
58.Fn vfprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
59.Ft int
60.Fn vprintf_l "locale_t loc" "const char * restrict format" "va_list ap"
61.Ft int
62.Fn vsnprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "va_list ap"
63.Ft int
64.Fn vsprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
65.Sh DESCRIPTION
66The above functions are used to convert formatted output in the locale
67.Fa loc .
68They behave in the same way as the versions without the _l suffix, but use
69the specified locale rather than the global or per-thread locale.
70See the specific manual pages for more information.
71.Sh SEE ALSO
72.Xr printf 3 ,
73.Xr xlocale 3
74.Sh STANDARDS
75These functions do not conform to any specific standard so they should be
76considered as non-portable local extensions.
77.Sh HISTORY
78These functions first appeared in Darwin and were first implemented in
79.Fx 9.1 .
80