Libc-1158.1.2.tar.gz

[apple/libc.git] / locale / FreeBSD / wcstol.3

.\" Copyright (c) 2002 Tim J. Robbins
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/lib/libc/locale/wcstol.3,v 1.4 2002/11/29 17:35:09 ru Exp $
.\"
.Dd September 7, 2002
.Dt WCSTOL 3
.Os
.Sh NAME
.Nm wcstoimax ,
.Nm wcstol ,
.Nm wcstoll ,
.Nm wcstoul ,
.Nm wcstoull ,
.Nm wcstoumax
.Nd "convert a wide character string value to a"
.Vt intmax_t ,
.Vt long ,
.Vt "long long" ,
.Vt "unsigned long" ,
.Vt "unsigned long long" ,
or
.Vt uintmax_t
integer
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft long
.Fo wcstol
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.Ft "long long"
.Fo wcstoll
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.Ft "unsigned long"
.Fo wcstoul
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.Ft "unsigned long long"
.Fo wcstoull
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.In stddef.h
.In inttypes.h
.Ft intmax_t
.Fo wcstoimax
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.Ft uintmax_t
.Fo wcstoumax
.Fa "const wchar_t *restrict nptr"
.Fa "wchar_t **restrict endptr"
.Fa "int base"
.Fc
.Sh DESCRIPTION
The
.Fn wcstol ,
.Fn wcstoul ,
.Fn wcstoll ,
.Fn wcstoull ,
.Fn wcstoimax ,
and
.Fn wcstoumax
functions are wide-character versions of the
.Fn strtol ,
.Fn strtoul ,
.Fn strtoll ,
.Fn strtoull ,
.Fn strtoimax ,
and
.Fn strtoumax
functions, respectively.
Refer to their manual pages (for example
.Xr strtol 3 )
for details.
.Pp
Extended locale versions of these functions are documented in
.Xr wcstol_l 3 .
See
.Xr xlocale 3
for more information.
.Sh LEGACY SYNOPSIS
.Fd #include <stddef.h>
.Fd #include <inttypes.h>
.Pp
The include file
.In stddef.h
is necessary for the
.Fn wcstoimax
and
.Fn wcstoumax
functions.
.Sh SEE ALSO
.Xr strtol 3 ,
.Xr strtoul 3 ,
.Xr wcstol_l 3 ,
.Xr compat 5
.Sh STANDARDS
The
.Fn wcstol ,
.Fn wcstoul ,
.Fn wcstoll ,
.Fn wcstoull ,
.Fn wcstoimax ,
and
.Fn wcstoumax
functions conform to
.St -isoC-99 .