lib/libc/locale/wcstol.3

   1 .\" Copyright (c) 2002 Tim J. Robbins
   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$
  26 .\"
  27 .Dd September 7, 2002
  28 .Dt WCSTOL 3
  29 .Os
  30 .Sh NAME
  31 .Nm wcstol , wcstoul ,
  32 .Nm wcstoll , wcstoull ,
  33 .Nm wcstoimax , wcstoumax
  34 .Nd "convert a wide character string value to a"
  35 .Vt long ,
  36 .Vt "unsigned long" ,
  37 .Vt "long long" ,
  38 .Vt "unsigned long long" ,
  39 .Vt intmax_t
  40 or
  41 .Vt uintmax_t
  42 integer
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In wchar.h
  47 .Ft long
  48 .Fn wcstol "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  49 .Ft "unsigned long"
  50 .Fn wcstoul "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  51 .Ft "long long"
  52 .Fn wcstoll "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  53 .Ft "unsigned long long"
  54 .Fn wcstoull "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  55 .In inttypes.h
  56 .Ft intmax_t
  57 .Fn wcstoimax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  58 .Ft uintmax_t
  59 .Fn wcstoumax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  60 .Sh DESCRIPTION
  61 The
  62 .Fn wcstol ,
  63 .Fn wcstoul ,
  64 .Fn wcstoll ,
  65 .Fn wcstoull ,
  66 .Fn wcstoimax
  67 and
  68 .Fn wcstoumax
  69 functions are wide-character versions of the
  70 .Fn strtol ,
  71 .Fn strtoul ,
  72 .Fn strtoll ,
  73 .Fn strtoull ,
  74 .Fn strtoimax
  75 and
  76 .Fn strtoumax
  77 functions, respectively.
  78 Refer to their manual pages (for example
  79 .Xr strtol 3 )
  80 for details.
  81 .Sh SEE ALSO
  82 .Xr strtol 3 ,
  83 .Xr strtoul 3
  84 .Sh STANDARDS
  85 The
  86 .Fn wcstol ,
  87 .Fn wcstoul ,
  88 .Fn wcstoll ,
  89 .Fn wcstoull ,
  90 .Fn wcstoimax
  91 and
  92 .Fn wcstoumax
  93 functions conform to
  94 .St -isoC-99 .