git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	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: src/lib/libc/locale/wcstol.3,v 1.4 2002/11/29 17:35:09 ru Exp $
	26	.\"
	27	.Dd September 7, 2002
	28	.Dt WCSTOL 3
	29	.Os
	30	.Sh NAME
	31	.Nm wcstoimax ,
	32	.Nm wcstol ,
	33	.Nm wcstoll ,
	34	.Nm wcstoul ,
	35	.Nm wcstoull ,
	36	.Nm wcstoumax
	37	.Nd "convert a wide character string value to a"
	38	.Vt intmax_t ,
	39	.Vt long ,
	40	.Vt "long long" ,
	41	.Vt "unsigned long" ,
	42	.Vt "unsigned long long" ,
	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	.Fo wcstol
	52	.Fa "const wchar_t *restrict nptr"
	53	.Fa "wchar_t **restrict endptr"
	54	.Fa "int base"
	55	.Fc
	56	.Ft "long long"
	57	.Fo wcstoll
	58	.Fa "const wchar_t *restrict nptr"
	59	.Fa "wchar_t **restrict endptr"
	60	.Fa "int base"
	61	.Fc
	62	.Ft "unsigned long"
	63	.Fo wcstoul
	64	.Fa "const wchar_t *restrict nptr"
	65	.Fa "wchar_t **restrict endptr"
	66	.Fa "int base"
	67	.Fc
	68	.Ft "unsigned long long"
	69	.Fo wcstoull
	70	.Fa "const wchar_t *restrict nptr"
	71	.Fa "wchar_t **restrict endptr"
	72	.Fa "int base"
	73	.Fc
	74	.In stddef.h
	75	.In inttypes.h
	76	.Ft intmax_t
	77	.Fo wcstoimax
	78	.Fa "const wchar_t *restrict nptr"
	79	.Fa "wchar_t **restrict endptr"
	80	.Fa "int base"
	81	.Fc
	82	.Ft uintmax_t
	83	.Fo wcstoumax
	84	.Fa "const wchar_t *restrict nptr"
	85	.Fa "wchar_t **restrict endptr"
	86	.Fa "int base"
	87	.Fc
	88	.Sh DESCRIPTION
	89	The
	90	.Fn wcstol ,
	91	.Fn wcstoul ,
	92	.Fn wcstoll ,
	93	.Fn wcstoull ,
	94	.Fn wcstoimax ,
	95	and
	96	.Fn wcstoumax
	97	functions are wide-character versions of the
	98	.Fn strtol ,
	99	.Fn strtoul ,
	100	.Fn strtoll ,
	101	.Fn strtoull ,
	102	.Fn strtoimax ,
	103	and
	104	.Fn strtoumax
	105	functions, respectively.
	106	Refer to their manual pages (for example
	107	.Xr strtol 3 )
	108	for details.
	109	.Pp
	110	Extended locale versions of these functions are documented in
	111	.Xr wcstol_l 3 .
	112	See
	113	.Xr xlocale 3
	114	for more information.
	115	.Sh LEGACY SYNOPSIS
	116	.Fd #include <stddef.h>
	117	.Fd #include <inttypes.h>
	118	.Pp
	119	The include file
	120	.In stddef.h
	121	is necessary for the
	122	.Fn wcstoimax
	123	and
	124	.Fn wcstoumax
	125	functions.
	126	.Sh SEE ALSO
	127	.Xr strtol 3 ,
	128	.Xr strtoul 3 ,
	129	.Xr wcstol_l 3 ,
	130	.Xr compat 5
	131	.Sh STANDARDS
	132	The
	133	.Fn wcstol ,
	134	.Fn wcstoul ,
	135	.Fn wcstoll ,
	136	.Fn wcstoull ,
	137	.Fn wcstoimax ,
	138	and
	139	.Fn wcstoumax
	140	functions conform to
	141	.St -isoC-99 .