[apple/libc.git] / stdio / printf_l.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" 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.
.\"
.\"     @(#)printf.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/stdio/printf.3,v 1.58 2004/10/16 16:00:01 stefanf Exp $
.\"
.Dd March 11, 2005
.Dt PRINTF_L 3
.Os
.Sh NAME
.Nm printf_l , fprintf_l , sprintf_l , snprintf_l , asprintf_l ,
.Nm vprintf_l , vfprintf_l , vsprintf_l , vsnprintf_l , vasprintf_l
.Nd formatted output conversion
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In xlocale.h
.Ft int
.Fn printf_l "locale_t loc" "const char * restrict format" ...
.Ft int
.Fn fprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" ...
.Ft int
.Fn sprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" ...
.Ft int
.Fn snprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" ...
.Ft int
.Fn asprintf_l "char **ret" "locale_t loc" "const char *format" ...
.In stdarg.h
.Ft int
.Fn vprintf_l "locale_t loc" "const char * restrict format" "va_list ap"
.Ft int
.Fn vfprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
.Ft int
.Fn vsprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
.Ft int
.Fn vsnprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "va_list ap"
.Ft int
.Fn vasprintf_l "char **ret" "locale_t loc" "const char *format" "va_list ap"
.Sh DESCRIPTION
The
.Fn printf_l ,
.Fn fprintf_l ,
.Fn sprintf_l ,
.Fn snprintf_l ,
.Fn asprintf_l ,
.Fn vprintf_l ,
.Fn vfprintf_l ,
.Fn vsprintf_l ,
.Fn vsnprintf_l ,
and
.Fn vasprintf_l
functions are extended locale versions of the
.Fn printf ,
.Fn fprintf ,
.Fn sprintf ,
.Fn snprintf ,
.Fn asprintf ,
.Fn vprintf ,
.Fn vfprintf ,
.Fn vsprintf ,
.Fn vsnprintf ,
and
.Fn vasprintf
functions, respectively.
Refer to their manual pages for details.
Also, see
.Xr xlocale 3 for more information about extended locales.
.Sh SEE ALSO
.Xr printf 3 ,
.Xr xlocale 3
Commit	Line	Data
3d9156a7 A	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. All advertising materials mentioning features or use of this software
	17	.\" must display the following acknowledgement:
	18	.\" This product includes software developed by the University of
	19	.\" California, Berkeley and its contributors.
	20	.\" 4. Neither the name of the University nor the names of its contributors
	21	.\" may be used to endorse or promote products derived from this software
	22	.\" without specific prior written permission.
	23	.\"
	24	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	.\" SUCH DAMAGE.
	35	.\"
	36	.\" @(#)printf.3 8.1 (Berkeley) 6/4/93
	37	.\" $FreeBSD: src/lib/libc/stdio/printf.3,v 1.58 2004/10/16 16:00:01 stefanf Exp $
	38	.\"
	39	.Dd March 11, 2005
	40	.Dt PRINTF_L 3
	41	.Os
	42	.Sh NAME
	43	.Nm printf_l , fprintf_l , sprintf_l , snprintf_l , asprintf_l ,
	44	.Nm vprintf_l , vfprintf_l , vsprintf_l , vsnprintf_l , vasprintf_l
	45	.Nd formatted output conversion
	46	.Sh LIBRARY
	47	.Lb libc
	48	.Sh SYNOPSIS
	49	.In stdio.h
	50	.In xlocale.h
	51	.Ft int
	52	.Fn printf_l "locale_t loc" "const char * restrict format" ...
	53	.Ft int
	54	.Fn fprintf_l "FILE * restrict stream" "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 snprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" ...
	59	.Ft int
	60	.Fn asprintf_l "char *ret" "locale_t loc" "const char format" ...
	61	.In stdarg.h
	62	.Ft int
	63	.Fn vprintf_l "locale_t loc" "const char * restrict format" "va_list ap"
	64	.Ft int
65	.Fn vfprintf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
66	.Ft int
67	.Fn vsprintf_l "char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
68	.Ft int
69	.Fn vsnprintf_l "char * restrict str" "size_t size" "locale_t loc" "const char * restrict format" "va_list ap"
70	.Ft int
71	.Fn vasprintf_l "char *ret" "locale_t loc" "const char format" "va_list ap"
72	.Sh DESCRIPTION
73	The
74	.Fn printf_l ,
75	.Fn fprintf_l ,
76	.Fn sprintf_l ,
77	.Fn snprintf_l ,
78	.Fn asprintf_l ,
79	.Fn vprintf_l ,
80	.Fn vfprintf_l ,
81	.Fn vsprintf_l ,
82	.Fn vsnprintf_l ,
83	and
84	.Fn vasprintf_l
85	functions are extended locale versions of the
86	.Fn printf ,
87	.Fn fprintf ,
88	.Fn sprintf ,
89	.Fn snprintf ,
90	.Fn asprintf ,
91	.Fn vprintf ,
92	.Fn vfprintf ,
93	.Fn vsprintf ,
94	.Fn vsnprintf ,
95	and
96	.Fn vasprintf
97	functions, respectively.
98	Refer to their manual pages for details.
99	Also, see
100	.Xr xlocale 3 for more information about extended locales.
101	.Sh SEE ALSO
102	.Xr printf 3 ,
103	.Xr xlocale 3