lib/libc/locale/wcstol.3

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