lib/libc/stdio/scanf_l.3

   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 .\" $FreeBSD: head/lib/libc/stdio/scanf_l.3 240518 2012-09-14 21:28:56Z eadler $
  26 .\"
  27 .Dd November 17, 2013
  28 .Dt SCANF_L 3
  29 .Os
  30 .Sh NAME
  31 .Nm scanf_l ,
  32 .Nm fscanf_l ,
  33 .Nm sscanf_l ,
  34 .Nm vfscanf_l ,
  35 .Nm vscanf_l ,
  36 .Nm vsscanf_l
  37 .Nd input format conversion
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In stdio.h
  42 .In xlocale.h
  43 .Ft int
  44 .Fn scanf_l "locale_t loc" "const char * restrict format" "..."
  45 .Ft int
  46 .Fn fscanf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "..."
  47 .Ft int
  48 .Fn sscanf_l "const char * restrict str" "locale_t loc" "const char * restrict format" "..."
  49 .Ft int
  50 .Fn vfscanf_l "FILE * restrict stream" "locale_t loc" "const char * restrict format" "va_list ap"
  51 .Ft int
  52 .Fn vscanf_l "locale_t loc" "const char * restrict format" "va_list ap"
  53 .Ft int
  54 .Fn vsscanf_l "const char * restrict str" "locale_t loc" "const char * restrict format" "va_list ap"
  55 .Sh DESCRIPTION
  56 The above functions scan input according to a specified
  57 .Fa format
  58 in the locale
  59 .Fa loc .
  60 They behave in the same way as the versions without the _l suffix, but use
  61 the specific locale rather than the global or per-thread locale.
  62 See the specific manual pages for more information.
  63 .Sh SEE ALSO
  64 .Xr scanf 3 ,
  65 .Xr xlocale 3
  66 .Sh STANDARDS
  67 These functions do not conform to any specific standard so they should be
  68 considered as non-portable local extensions.
  69 .Sh HISTORY
  70 These functions first appeared in Darwin and were first implemented in
  71 .Fx 9.1 .