xref: /openbsd/lib/libc/locale/wcstol.3 (revision 4cfece93)
1.\" $OpenBSD: wcstol.3,v 1.4 2015/09/10 15:53:26 schwarze Exp $
2.\" $NetBSD: wcstol.3,v 1.2 2006/08/08 17:32:05 wiz 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 $Mdocdate: September 10 2015 $
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 long, unsigned long, \
38long long, unsigned long long, intmax_t, or uintmax_t integer
39.Sh SYNOPSIS
40.In wchar.h
41.Ft long
42.Fn wcstol "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
43.Ft "unsigned long"
44.Fn wcstoul "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
45.Ft "long long"
46.Fn wcstoll "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
47.Ft "unsigned long long"
48.Fn wcstoull "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
49.In inttypes.h
50.Ft intmax_t
51.Fn wcstoimax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
52.Ft uintmax_t
53.Fn wcstoumax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
54.Sh DESCRIPTION
55The
56.Fn wcstol ,
57.Fn wcstoul ,
58.Fn wcstoll ,
59.Fn wcstoull ,
60.Fn wcstoimax
61and
62.Fn wcstoumax
63functions are wide-character versions of the
64.Fn strtol ,
65.Fn strtoul ,
66.Fn strtoll ,
67.Fn strtoull ,
68.Fn strtoimax
69and
70.Fn strtoumax
71functions, respectively.
72Refer to their manual pages (for example
73.Xr strtol 3 )
74for details.
75.Sh SEE ALSO
76.Xr strtol 3 ,
77.Xr strtoul 3
78.Sh STANDARDS
79The
80.Fn wcstol ,
81.Fn wcstoul ,
82.Fn wcstoll ,
83.Fn wcstoull ,
84.Fn wcstoimax
85and
86.Fn wcstoumax
87functions conform to
88.St -isoC-99 .
89