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