lib/libc/stdio/wscanf_l.3

   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. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)scanf.3     8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: head/lib/libc/stdio/wscanf.3 235363 2012-05-12 20:27:13Z joel $
  34 .\"
  35 .Dd November 17, 2013
  36 .Dt WSCANF_L 3
  37 .Os
  38 .Sh NAME
  39 .Nm wscanf_l ,
  40 .Nm fwscanf_l ,
  41 .Nm swscanf_l ,
  42 .Nm vwscanf_l ,
  43 .Nm vswscanf_l ,
  44 .Nm vfwscanf_l
  45 .Nd wide character input format conversion
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdio.h
  50 .In wchar.h
  51 .In xlocale.h
  52 .Ft int
  53 .Fn wscanf_l "locale_t loc" "const wchar_t * restrict format" ...
  54 .Ft int
  55 .Fn fwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" ...
  56 .Ft int
  57 .Fn swscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" ...
  58 .In stdarg.h
  59 .Ft int
  60 .Fn vwscanf_l "locale_t loc" "const wchar_t * restrict format" "va_list ap"
  61 .Ft int
  62 .Fn vswscanf_l "const wchar_t * restrict str" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
  63 .Ft int
  64 .Fn vfwscanf_l "FILE * restrict stream" "locale_t loc" "const wchar_t * restrict format" "va_list ap"
  65 .Sh DESCRIPTION
  66 The above functions scan input according to a specified
  67 .Fa format
  68 in the locale
  69 .Fa loc .
  70 They behave in the same way as the versions without the _l suffix, but use
  71 the specified locale rather than the global or per-thread locale.
  72 See the specific manual pages for more information.
  73 .Sh SEE ALSO
  74 .Xr wscanf 3 ,
  75 .Xr xlocale 3
  76 .Sh STANDARDS
  77 These functions do not conform to any specific standard so they should be
  78 considered as non-portable local extensions.