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

.\" Copyright (c) 2002, 2003 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/wcstod.3,v 1.3 2003/03/13 06:29:53 tjr Exp $
.\"
.Dd February 22, 2003
.Dt WCSTOD 3
.Os
.Sh NAME
.Nm wcstof ,
.Nm wcstod ,
.Nm wcstold
.Nd "convert string to float, double or long double"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft float
.Fn wcstof "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
.Ft long double
.Fn wcstold "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
.Ft double
.Fn wcstod "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
.Sh DESCRIPTION
The
.Fn wcstof ,
.Fn wcstod
and
.Fn wcstold
functions are the wide-character versions of the
.Fn strtof ,
.Fn strtod
and
.Fn strtold
functios.
Refer to
.Xr strtod 3
for details.
.Sh SEE ALSO
.Xr strtod 3 ,
.Xr wcstol 3 ,
.Sh STANDARDS
The
.Fn wcstof ,
.Fn wcstod
and
.Fn wcstold
functions conform to
.St -isoC-99 .
Commit	Line	Data
9385eb3d	1	.\" Copyright (c) 2002, 2003 Tim J. Robbins
5b2abdfb A	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	.\"
9385eb3d	25	.\" $FreeBSD: src/lib/libc/locale/wcstod.3,v 1.3 2003/03/13 06:29:53 tjr Exp $
5b2abdfb	26	.\"
9385eb3d A	27	.Dd February 22, 2003
9385eb3d A	28	.Dt WCSTOD 3
5b2abdfb A	29	.Os
5b2abdfb A	30	.Sh NAME
9385eb3d A	31	.Nm wcstof ,
	32	.Nm wcstod ,
	33	.Nm wcstold
	34	.Nd "convert string to float, double or long double"
5b2abdfb A	35	.Sh LIBRARY
	36	.Lb libc
	37	.Sh SYNOPSIS
9385eb3d A	38	.In wchar.h
	39	.Ft float
	40	.Fn wcstof "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
	41	.Ft long double
	42	.Fn wcstold "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
	43	.Ft double
	44	.Fn wcstod "const wchar_t * restrict nptr" "wchar_t ** restrict endptr"
5b2abdfb	45	.Sh DESCRIPTION
9385eb3d A	46	The
	47	.Fn wcstof ,
	48	.Fn wcstod
	49	and
	50	.Fn wcstold
	51	functions are the wide-character versions of the
	52	.Fn strtof ,
	53	.Fn strtod
	54	and
	55	.Fn strtold
	56	functios.
	57	Refer to
	58	.Xr strtod 3
	59	for details.
5b2abdfb	60	.Sh SEE ALSO
9385eb3d A	61	.Xr strtod 3 ,
	62	.Xr wcstol 3 ,
	63	.Sh STANDARDS
5b2abdfb	64	The
9385eb3d A	65	.Fn wcstof ,
	66	.Fn wcstod
	67	and
	68	.Fn wcstold
	69	functions conform to
	70	.St -isoC-99 .