xref: /dragonfly/lib/libc/locale/wcstol.3 (revision cfd1aba3)
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: head/lib/libc/locale/wcstol.3 107392 2002-11-29 17:35:09Z ru $
26.\"
27.Dd December 25, 2013
28.Dt WCSTOL 3
29.Os
30.Sh NAME
31.Nm wcstol ,
32.Nm wcstol_l ,
33.Nm wcstoul ,
34.Nm wcstoul_l ,
35.Nm wcstoll ,
36.Nm wcstoll_l ,
37.Nm wcstoull ,
38.Nm wcstoull_l ,
39.Nm wcstoimax ,
40.Nm wcstoimax_l ,
41.Nm wcstoumax ,
42.Nm wcstoumax_l
43.Nd "convert a wide character string value to a"
44.Vt long ,
45.Vt "unsigned long" ,
46.Vt "long long" ,
47.Vt "unsigned long long" ,
48.Vt intmax_t
49or
50.Vt uintmax_t
51integer
52.Sh LIBRARY
53.Lb libc
54.Sh SYNOPSIS
55.In wchar.h
56.Ft long
57.Fn wcstol "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
58.Ft "unsigned long"
59.Fn wcstoul "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
60.Ft "long long"
61.Fn wcstoll "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
62.Ft "unsigned long long"
63.Fn wcstoull "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
64.In inttypes.h
65.Ft intmax_t
66.Fn wcstoimax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
67.Ft uintmax_t
68.Fn wcstoumax "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base"
69.In xlocale.h
70.Ft long
71.Fn wcstol_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
72.Ft "unsigned long"
73.Fn wcstoul_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
74.Ft "long long"
75.Fn wcstoll_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
76.Ft "unsigned long long"
77.Fn wcstoull_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
78.Ft intmax_t
79.Fn wcstoimax_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
80.Ft uintmax_t
81.Fn wcstoumax_l "const wchar_t * restrict nptr" "wchar_t ** restrict endptr" "int base" "locale_t locale"
82.Sh DESCRIPTION
83The
84.Fn wcstol ,
85.Fn wcstol_l ,
86.Fn wcstoul ,
87.Fn wcstoul_l ,
88.Fn wcstoll ,
89.Fn wcstoll_l ,
90.Fn wcstoull ,
91.Fn wcstoull_l ,
92.Fn wcstoimax ,
93.Fn wcstoimax_l ,
94.Fn wcstoumax ,
95and
96.Fn wcstoumax_l
97functions are wide-character versions of the
98.Fn strtol ,
99.Fn strtol_l ,
100.Fn strtoul ,
101.Fn strtoul_l ,
102.Fn strtoll ,
103.Fn strtoll_l ,
104.Fn strtoull ,
105.Fn strtoull_l ,
106.Fn strtoimax ,
107.Fn strtoimax_l ,
108.Fn strtoumax ,
109and
110.Fn strtoumax_l
111functions, respectively.
112Refer to their manual pages (for example
113.Xr strtol 3 )
114for details.
115.Sh SEE ALSO
116.Xr strtol 3 ,
117.Xr strtoul 3 ,
118.Xr xlocale 3
119.Sh STANDARDS
120The
121.Fn wcstol ,
122.Fn wcstoul ,
123.Fn wcstoll ,
124.Fn wcstoull ,
125.Fn wcstoimax
126and
127.Fn wcstoumax
128functions conform to
129.St -isoC-99 .
130