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