[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 asprintf_l ,
.Nm fprintf_l ,
.Nm printf_l ,
.Nm snprintf_l ,
.Nm sprintf_l ,
.Nm vasprintf_l ,
.Nm vfprintf_l ,
.Nm vprintf_l ,
.Nm vsnprintf_l ,
.Nm vsprintf_l
.Nd formatted output conversion
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In xlocale.h
.Ft int
.Fo asprintf_l
.Fa "char **ret"
.Fa "locale_t loc"
.Fa "const char *format"
.Fa ...
.Fc
.Ft int
.Fo fprintf_l
.Fa "FILE * restrict stream"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa ...
.Fc
.Ft int
.Fo printf_l
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa ...
.Fc
.Ft int
.Fo snprintf_l
.Fa "char * restrict str"
.Fa "size_t size"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa ...
.Fc
.Ft int
.Fo sprintf_l
.Fa "char * restrict str"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa ...
.Fc
.In stdarg.h
.In xlocale.h
.Ft int
.Fo vasprintf_l
.Fa "char **ret"
.Fa "locale_t loc"
.Fa "const char *format"
.Fa "va_list ap"
.Fc
.Ft int
.Fo vfprintf_l
.Fa "FILE * restrict stream"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa "va_list ap"
.Fc
.Ft int
.Fo vprintf_l
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa "va_list ap"
.Fc
.Ft int
.Fo vsnprintf_l
.Fa "char * restrict str"
.Fa "size_t size"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa "va_list ap"
.Fc
.Ft int
.Fo vsprintf_l
.Fa "char * restrict str"
.Fa "locale_t loc"
.Fa "const char * restrict format"
.Fa "va_list ap"
.Fc
.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
224c7076 A	43	.Nm asprintf_l ,
	44	.Nm fprintf_l ,
	45	.Nm printf_l ,
	46	.Nm snprintf_l ,
	47	.Nm sprintf_l ,
	48	.Nm vasprintf_l ,
	49	.Nm vfprintf_l ,
	50	.Nm vprintf_l ,
	51	.Nm vsnprintf_l ,
	52	.Nm vsprintf_l
3d9156a7 A	53	.Nd formatted output conversion
	54	.Sh LIBRARY
	55	.Lb libc
	56	.Sh SYNOPSIS
	57	.In stdio.h
	58	.In xlocale.h
	59	.Ft int
224c7076 A	60	.Fo asprintf_l
	61	.Fa "char **ret"
	62	.Fa "locale_t loc"
	63	.Fa "const char *format"
	64	.Fa ...
	65	.Fc
3d9156a7	66	.Ft int
224c7076 A	67	.Fo fprintf_l
	68	.Fa "FILE * restrict stream"
	69	.Fa "locale_t loc"
	70	.Fa "const char * restrict format"
	71	.Fa ...
	72	.Fc
3d9156a7	73	.Ft int
224c7076 A	74	.Fo printf_l
	75	.Fa "locale_t loc"
	76	.Fa "const char * restrict format"
	77	.Fa ...
	78	.Fc
3d9156a7	79	.Ft int
224c7076 A	80	.Fo snprintf_l
	81	.Fa "char * restrict str"
	82	.Fa "size_t size"
	83	.Fa "locale_t loc"
	84	.Fa "const char * restrict format"
	85	.Fa ...
	86	.Fc
3d9156a7	87	.Ft int
224c7076 A	88	.Fo sprintf_l
	89	.Fa "char * restrict str"
	90	.Fa "locale_t loc"
	91	.Fa "const char * restrict format"
	92	.Fa ...
	93	.Fc
3d9156a7	94	.In stdarg.h
224c7076	95	.In xlocale.h
3d9156a7	96	.Ft int
224c7076 A	97	.Fo vasprintf_l
	98	.Fa "char **ret"
	99	.Fa "locale_t loc"
	100	.Fa "const char *format"
	101	.Fa "va_list ap"
	102	.Fc
3d9156a7	103	.Ft int
224c7076 A	104	.Fo vfprintf_l
	105	.Fa "FILE * restrict stream"
	106	.Fa "locale_t loc"
	107	.Fa "const char * restrict format"
	108	.Fa "va_list ap"
	109	.Fc
3d9156a7	110	.Ft int
224c7076 A	111	.Fo vprintf_l
	112	.Fa "locale_t loc"
	113	.Fa "const char * restrict format"
	114	.Fa "va_list ap"
	115	.Fc
3d9156a7	116	.Ft int
224c7076 A	117	.Fo vsnprintf_l
	118	.Fa "char * restrict str"
	119	.Fa "size_t size"
	120	.Fa "locale_t loc"
	121	.Fa "const char * restrict format"
	122	.Fa "va_list ap"
	123	.Fc
3d9156a7	124	.Ft int
224c7076 A	125	.Fo vsprintf_l
	126	.Fa "char * restrict str"
	127	.Fa "locale_t loc"
	128	.Fa "const char * restrict format"
	129	.Fa "va_list ap"
	130	.Fc
3d9156a7 A	131	.Sh DESCRIPTION
	132	The
	133	.Fn printf_l ,
	134	.Fn fprintf_l ,
	135	.Fn sprintf_l ,
	136	.Fn snprintf_l ,
	137	.Fn asprintf_l ,
	138	.Fn vprintf_l ,
	139	.Fn vfprintf_l ,
	140	.Fn vsprintf_l ,
	141	.Fn vsnprintf_l ,
	142	and
	143	.Fn vasprintf_l
	144	functions are extended locale versions of the
	145	.Fn printf ,
	146	.Fn fprintf ,
	147	.Fn sprintf ,
	148	.Fn snprintf ,
	149	.Fn asprintf ,
	150	.Fn vprintf ,
	151	.Fn vfprintf ,
	152	.Fn vsprintf ,
	153	.Fn vsnprintf ,
	154	and
	155	.Fn vasprintf
	156	functions, respectively.
	157	Refer to their manual pages for details.
	158	Also, see
	159	.Xr xlocale 3 for more information about extended locales.
	160	.Sh SEE ALSO
	161	.Xr printf 3 ,
	162	.Xr xlocale 3