lib/libc/locale/wcstol.3

   1 .\" $NetBSD: wcstol.3,v 1.3 2010/12/16 17:42:27 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2002 Tim J. Robbins
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/lib/libc/locale/wcstol.3,v 1.4 2002/11/29 17:35:09 ru Exp $
  28 .\"
  29 .Dd September 7, 2002
  30 .Dt WCSTOL 3
  31 .Os
  32 .Sh NAME
  33 .Nm wcstol , wcstoul ,
  34 .Nm wcstoll , wcstoull ,
  35 .Nm wcstoimax , wcstoumax
  36 .Nd "convert a wide-character string value to a"
  37 .Vt long ,
  38 .Vt "unsigned long" ,
  39 .Vt "long long" ,
  40 .Vt "unsigned long long" ,
  41 .Vt intmax_t
  42 or
  43 .Vt uintmax_t
  44 integer
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In wchar.h
  49 .Ft long
  50 .Fn wcstol "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  51 .Ft "unsigned long"
  52 .Fn wcstoul "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  53 .Ft "long long"
  54 .Fn wcstoll "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  55 .Ft "unsigned long long"
  56 .Fn wcstoull "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  57 .In inttypes.h
  58 .Ft intmax_t
  59 .Fn wcstoimax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  60 .Ft uintmax_t
  61 .Fn wcstoumax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
  62 .Sh DESCRIPTION
  63 The
  64 .Fn wcstol ,
  65 .Fn wcstoul ,
  66 .Fn wcstoll ,
  67 .Fn wcstoull ,
  68 .Fn wcstoimax
  69 and
  70 .Fn wcstoumax
  71 functions are wide-character versions of the
  72 .Fn strtol ,
  73 .Fn strtoul ,
  74 .Fn strtoll ,
  75 .Fn strtoull ,
  76 .Fn strtoimax
  77 and
  78 .Fn strtoumax
  79 functions, respectively.
  80 Refer to their manual pages (for example
  81 .Xr strtol 3 )
  82 for details.
  83 .Sh SEE ALSO
  84 .Xr strtol 3 ,
  85 .Xr strtoul 3
  86 .Sh STANDARDS
  87 The
  88 .Fn wcstol ,
  89 .Fn wcstoul ,
  90 .Fn wcstoll ,
  91 .Fn wcstoull ,
  92 .Fn wcstoimax
  93 and
  94 .Fn wcstoumax
  95 functions conform to
  96 .St -isoC-99 .