[apple/libc.git] / stdio / wscanf_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.
.\"
.\"     @(#)scanf.3	8.2 (Berkeley) 12/11/93
.\" FreeBSD: src/lib/libc/stdio/scanf.3,v 1.24 2003/06/28 09:03:25 das Exp
.\" $FreeBSD: src/lib/libc/stdio/wscanf.3,v 1.6 2003/07/05 07:47:55 tjr Exp $
.\"
.Dd March 11, 2005
.Dt WSCANF_L 3
.Os
.Sh NAME
.Nm wscanf_l ,
.Nm fwscanf_l ,
.Nm swscanf_l ,
.Nm vwscanf_l ,
.Nm vswscanf_l ,
.Nm vfwscanf_l
.Nd wide character input format conversion
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.In wchar.h
.In xlocale.h
.Ft int
.Fn wscanf_l "locale_t loc" "const wchar_t * restrict format" ...
.Ft int
.Fn fwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" ...
.Ft int
.Fn swscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" ...
.In stdarg.h
.Ft int
.Fn vwscanf_l "locale_t loc" "const wchar_t * restrict format" "va_list ap"
.Ft int
.Fn vswscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
.Ft int
.Fn vfwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
.Sh DESCRIPTION
The
.Fn wscanf_l ,
.Fn fwscanf_l ,
.Fn swscanf_l ,
.Fn vwscanf_l ,
.Fn vswscanf_l ,
and
.Fn vfwscanf_l
functions are extended locale versions of the
.Fn wscanf ,
.Fn fwscanf ,
.Fn swscanf ,
.Fn vwscanf ,
.Fn vswscanf ,
and
.Fn vfwscanf
functions, respectively.
Refer to their manual pages for details.
Also, see
.Xr xlocale 3 for more information about extended locales.
.Sh SEE ALSO
.Xr wscanf 3 ,
.Xr xlocale 3
Commit	Line	Data
3d9156a7	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb	4	.\" This code is derived from software contributed to Berkeley by
3d9156a7 A	5	.\" Chris Torek and the American National Standards Committee X3,
3d9156a7 A	6	.\" on Information Processing Systems.
5b2abdfb	7	.\"
e9ce8d39 A	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	.\"
3d9156a7 A	36	.\" @(#)scanf.3 8.2 (Berkeley) 12/11/93
	37	.\" FreeBSD: src/lib/libc/stdio/scanf.3,v 1.24 2003/06/28 09:03:25 das Exp
	38	.\" $FreeBSD: src/lib/libc/stdio/wscanf.3,v 1.6 2003/07/05 07:47:55 tjr Exp $
e9ce8d39	39	.\"
3d9156a7 A	40	.Dd March 11, 2005
3d9156a7 A	41	.Dt WSCANF_L 3
e9ce8d39 A	42	.Os
e9ce8d39 A	43	.Sh NAME
3d9156a7 A	44	.Nm wscanf_l ,
	45	.Nm fwscanf_l ,
	46	.Nm swscanf_l ,
	47	.Nm vwscanf_l ,
	48	.Nm vswscanf_l ,
	49	.Nm vfwscanf_l
	50	.Nd wide character input format conversion
	51	.Sh LIBRARY
	52	.Lb libc
e9ce8d39	53	.Sh SYNOPSIS
3d9156a7 A	54	.In stdio.h
	55	.In wchar.h
	56	.In xlocale.h
	57	.Ft int
	58	.Fn wscanf_l "locale_t loc" "const wchar_t * restrict format" ...
	59	.Ft int
	60	.Fn fwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" ...
	61	.Ft int
	62	.Fn swscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" ...
	63	.In stdarg.h
	64	.Ft int
	65	.Fn vwscanf_l "locale_t loc" "const wchar_t * restrict format" "va_list ap"
	66	.Ft int
	67	.Fn vswscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
	68	.Ft int
	69	.Fn vfwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
e9ce8d39 A	70	.Sh DESCRIPTION
e9ce8d39 A	71	The
3d9156a7 A	72	.Fn wscanf_l ,
	73	.Fn fwscanf_l ,
	74	.Fn swscanf_l ,
	75	.Fn vwscanf_l ,
	76	.Fn vswscanf_l ,
	77	and
	78	.Fn vfwscanf_l
	79	functions are extended locale versions of the
	80	.Fn wscanf ,
	81	.Fn fwscanf ,
	82	.Fn swscanf ,
	83	.Fn vwscanf ,
	84	.Fn vswscanf ,
	85	and
	86	.Fn vfwscanf
	87	functions, respectively.
	88	Refer to their manual pages for details.
	89	Also, see
	90	.Xr xlocale 3 for more information about extended locales.
	91	.Sh SEE ALSO
	92	.Xr wscanf 3 ,
	93	.Xr xlocale 3