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