Fix the __BSD_VISIBLE check in a few headers.
[dragonfly.git] / lib / libc / stdio / wprintf_l.3
blobf25a973cd02214df7de3637c07bdf54a8e01c80c
1 .\" Copyright (c) 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek and the American National Standards Committee X3,
6 .\" on Information Processing Systems.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)printf.3    8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: head/lib/libc/stdio/wprintf.3 208027 2010-05-13 12:07:55Z uqs $
34 .\"
35 .Dd November 17, 2013
36 .Dt WPRINTF_L 3
37 .Os
38 .Sh NAME
39 .Nm wprintf_l ,
40 .Nm fwprintf_l ,
41 .Nm swprintf_l ,
42 .Nm vfwprintf_l ,
43 .Nm vswprintf_l ,
44 .Nm vwprintf_l
45 .Nd formatted wide character output conversion
46 .Sh LIBRARY
47 .Lb libc
48 .Sh SYNOPSIS
49 .In stdio.h
50 .In wchar.h
51 .In xlocale.h
52 .Ft int
53 .Fn fwprintf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" ...
54 .Ft int
55 .Fn swprintf_l "wchar_t * restrict ws" "size_t n" "locale_t loc" "const wchar_t * restrict format" ...
56 .Ft int
57 .Fn wprintf_l "locale_t loc" "const wchar_t * restrict format" ...
58 .In stdarg.h
59 .Ft int
60 .Fn vfwprintf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
61 .Ft int
62 .Fn vswprintf_l "wchar_t * restrict ws" "size_t n" "locale_t loc" "const wchar_t *restrict format" "va_list ap"
63 .Ft int
64 .Fn vwprintf_l "locale_t loc" "const wchar_t * restrict format" "va_list ap"
65 .Sh DESCRIPTION
66 The above functions are used to convert formatted output in the locale
67 .Fa loc .
68 They behave in the same way as the versions without the _l suffix, but use
69 the specified locale rather than the global or per-thread locale.
70 See the specific manual pages for more information.
71 .Sh SEE ALSO
72 .Xr wprintf 3 ,
73 .Xr xlocale 3
74 .Sh STANDARDS
75 These functions do not conform to any specific standard so they should be
76 considered as non-portable local extensions.