xref: /freebsd/lib/libc/locale/wcsftime.3 (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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$
26.\"
27.Dd September 8, 2002
28.Dt WCSFTIME 3
29.Os
30.Sh NAME
31.Nm wcsftime
32.Nd "convert date and time to a wide-character string"
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In wchar.h
37.Ft size_t
38.Fo wcsftime
39.Fa "wchar_t * restrict wcs" "size_t maxsize"
40.Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
41.Fc
42.Sh DESCRIPTION
43The
44.Fn wcsftime
45function is equivalent to the
46.Fn strftime
47function except for the types of its arguments.
48Refer to
49.Xr strftime 3
50for a detailed description.
51.Sh COMPATIBILITY
52Some early implementations of
53.Fn wcsftime
54had a
55.Fa format
56argument with type
57.Vt "const char *"
58instead of
59.Vt "const wchar_t *" .
60.Sh SEE ALSO
61.Xr strftime 3
62.Sh STANDARDS
63The
64.Fn wcsftime
65function conforms to
66.St -isoC-99 .
67