xref: /dflybsd-src/lib/libc/stdio/scanf_l.3 (revision 371e3467e2106f39ca458e11bf359f1c69012f6a)
1*371e3467SSascha Wildner.\" Copyright (c) 2012 Isabell Long <issyl0@FreeBSD.org>
2*371e3467SSascha Wildner.\" All rights reserved.
3*371e3467SSascha Wildner.\"
4*371e3467SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
5*371e3467SSascha Wildner.\" modification, are permitted provided that the following conditions
6*371e3467SSascha Wildner.\" are met:
7*371e3467SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
8*371e3467SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
9*371e3467SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
10*371e3467SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in the
11*371e3467SSascha Wildner.\"    documentation and/or other materials provided with the distribution.
12*371e3467SSascha Wildner.\"
13*371e3467SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*371e3467SSascha Wildner.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*371e3467SSascha Wildner.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*371e3467SSascha Wildner.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*371e3467SSascha Wildner.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*371e3467SSascha Wildner.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*371e3467SSascha Wildner.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*371e3467SSascha Wildner.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*371e3467SSascha Wildner.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*371e3467SSascha Wildner.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*371e3467SSascha Wildner.\" SUCH DAMAGE.
24*371e3467SSascha Wildner.\"
25*371e3467SSascha Wildner.\" $FreeBSD: head/lib/libc/stdio/scanf_l.3 240518 2012-09-14 21:28:56Z eadler $
26*371e3467SSascha Wildner.\"
27*371e3467SSascha Wildner.Dd November 17, 2013
28*371e3467SSascha Wildner.Dt SCANF_L 3
29*371e3467SSascha Wildner.Os
30*371e3467SSascha Wildner.Sh NAME
31*371e3467SSascha Wildner.Nm scanf_l ,
32*371e3467SSascha Wildner.Nm fscanf_l ,
33*371e3467SSascha Wildner.Nm sscanf_l ,
34*371e3467SSascha Wildner.Nm vfscanf_l ,
35*371e3467SSascha Wildner.Nm vscanf_l ,
36*371e3467SSascha Wildner.Nm vsscanf_l
37*371e3467SSascha Wildner.Nd input format conversion
38*371e3467SSascha Wildner.Sh LIBRARY
39*371e3467SSascha Wildner.Lb libc
40*371e3467SSascha Wildner.Sh SYNOPSIS
41*371e3467SSascha Wildner.In stdio.h
42*371e3467SSascha Wildner.In xlocale.h
43*371e3467SSascha Wildner.Ft int
44*371e3467SSascha Wildner.Fn scanf_l "locale_t loc" "const char * restrict format" "..."
45*371e3467SSascha Wildner.Ft int
46*371e3467SSascha Wildner.Fn fscanf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "..."
47*371e3467SSascha Wildner.Ft int
48*371e3467SSascha Wildner.Fn sscanf_l "const char * restrict str" "locale_t loc" "const char * restrict format" "..."
49*371e3467SSascha Wildner.Ft int
50*371e3467SSascha Wildner.Fn vfscanf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
51*371e3467SSascha Wildner.Ft int
52*371e3467SSascha Wildner.Fn vscanf_l "locale_t loc" "const char * restrict format" "va_list ap"
53*371e3467SSascha Wildner.Ft int
54*371e3467SSascha Wildner.Fn vsscanf_l "const char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
55*371e3467SSascha Wildner.Sh DESCRIPTION
56*371e3467SSascha WildnerThe above functions scan input according to a specified
57*371e3467SSascha Wildner.Fa format
58*371e3467SSascha Wildnerin the locale
59*371e3467SSascha Wildner.Fa loc .
60*371e3467SSascha WildnerThey behave in the same way as the versions without the _l suffix, but use
61*371e3467SSascha Wildnerthe specific locale rather than the global or per-thread locale.
62*371e3467SSascha WildnerSee the specific manual pages for more information.
63*371e3467SSascha Wildner.Sh SEE ALSO
64*371e3467SSascha Wildner.Xr scanf 3 ,
65*371e3467SSascha Wildner.Xr xlocale 3
66*371e3467SSascha Wildner.Sh STANDARDS
67*371e3467SSascha WildnerThese functions do not conform to any specific standard so they should be
68*371e3467SSascha Wildnerconsidered as non-portable local extensions.
69*371e3467SSascha Wildner.Sh HISTORY
70*371e3467SSascha WildnerThese functions first appeared in Darwin and were first implemented in
71*371e3467SSascha Wildner.Fx 9.1 .
72