[apple/libc.git] / locale / FreeBSD / wcsftime.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/wcsftime.3,v 1.2 2002/11/29 17:35:09 ru Exp $
.\"
.Dd September 8, 2002
.Dt WCSFTIME 3
.Os
.Sh NAME
.Nm wcsftime ,
.Nm wcsftime_l
.Nd "convert date and time to a wide-character string"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft size_t
.Fo wcsftime
.Fa "wchar_t *restrict wcs"
.Fa "size_t maxsize"
.Fa "const wchar_t *restrict format"
.Fa "const struct tm *restrict timeptr"
.Fc
.In wchar.h
.In xlocale.h
.Ft size_t
.Fo wcsftime_l
.Fa "wchar_t *restrict wcs"
.Fa "size_t maxsize"
.Fa "const wchar_t *restrict format"
.Fa "const struct tm *restrict timeptr"
.Fa "locale_t loc"
.Fc
.Sh DESCRIPTION
The
.Fn wcsftime
function is equivalent to the
.Fn strftime
function, except for the types of its arguments.
Refer to
.Xr strftime 3
for a detailed description.
.Pp
While the
.Fn wcsftime
function uses the current locale, the
.Fn wcsftime_l
function may be passed a locale directly. See
.Xr xlocale 3
for more information.
.Sh COMPATIBILITY
Some early implementations of
.Fn wcsftime
had a
.Fa format
argument with type
.Vt "const char *" ,
instead of
.Vt "const wchar_t *" .
.Sh SEE ALSO
.Xr strftime 3 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn wcsftime
function conforms to
.St -isoC-99 .
Commit	Line	Data
9385eb3d A	1	.\" Copyright (c) 2002 Tim J. Robbins
9385eb3d A	2	.\" All rights reserved.
e9ce8d39 A	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.
e9ce8d39	12	.\"
9385eb3d	13	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
e9ce8d39 A	14	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
e9ce8d39 A	15	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
9385eb3d	16	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
e9ce8d39 A	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/wcsftime.3,v 1.2 2002/11/29 17:35:09 ru Exp $
e9ce8d39	26	.\"
9385eb3d A	27	.Dd September 8, 2002
9385eb3d A	28	.Dt WCSFTIME 3
e9ce8d39 A	29	.Os
e9ce8d39 A	30	.Sh NAME
ad3c9f2a A	31	.Nm wcsftime ,
ad3c9f2a A	32	.Nm wcsftime_l
9385eb3d	33	.Nd "convert date and time to a wide-character string"
e9ce8d39 A	34	.Sh LIBRARY
	35	.Lb libc
	36	.Sh SYNOPSIS
9385eb3d A	37	.In wchar.h
	38	.Ft size_t
	39	.Fo wcsftime
ad3c9f2a A	40	.Fa "wchar_t *restrict wcs"
	41	.Fa "size_t maxsize"
	42	.Fa "const wchar_t *restrict format"
	43	.Fa "const struct tm *restrict timeptr"
	44	.Fc
	45	.In wchar.h
	46	.In xlocale.h
	47	.Ft size_t
	48	.Fo wcsftime_l
	49	.Fa "wchar_t *restrict wcs"
	50	.Fa "size_t maxsize"
	51	.Fa "const wchar_t *restrict format"
	52	.Fa "const struct tm *restrict timeptr"
	53	.Fa "locale_t loc"
9385eb3d	54	.Fc
e9ce8d39 A	55	.Sh DESCRIPTION
e9ce8d39 A	56	The
9385eb3d A	57	.Fn wcsftime
	58	function is equivalent to the
	59	.Fn strftime
ad3c9f2a	60	function, except for the types of its arguments.
9385eb3d A	61	Refer to
	62	.Xr strftime 3
	63	for a detailed description.
ad3c9f2a A	64	.Pp
	65	While the
	66	.Fn wcsftime
	67	function uses the current locale, the
	68	.Fn wcsftime_l
	69	function may be passed a locale directly. See
	70	.Xr xlocale 3
	71	for more information.
9385eb3d A	72	.Sh COMPATIBILITY
	73	Some early implementations of
	74	.Fn wcsftime
	75	had a
	76	.Fa format
	77	argument with type
ad3c9f2a	78	.Vt "const char *" ,
9385eb3d A	79	instead of
9385eb3d A	80	.Vt "const wchar_t *" .
e9ce8d39	81	.Sh SEE ALSO
ad3c9f2a A	82	.Xr strftime 3 ,
ad3c9f2a A	83	.Xr xlocale 3
5b2abdfb	84	.Sh STANDARDS
e9ce8d39	85	The
9385eb3d	86	.Fn wcsftime
5b2abdfb	87	function conforms to
9385eb3d	88	.St -isoC-99 .