xref: /dragonfly/lib/libc/locale/wcsftime.3 (revision 6e5c5008)
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: head/lib/libc/locale/wcsftime.3 107392 2002-11-29 17:35:09Z ru $
26.\"
27.Dd December 26, 2013
28.Dt WCSFTIME 3
29.Os
30.Sh NAME
31.Nm wcsftime ,
32.Nm wcsftime_l
33.Nd "convert date and time to a wide-character string"
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In wchar.h
38.Ft size_t
39.Fo wcsftime
40.Fa "wchar_t * restrict wcs" "size_t maxsize"
41.Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
42.Fc
43.In xlocale.h
44.Ft size_t
45.Fo wcsftime_l
46.Fa "wchar_t * restrict wcs" "size_t maxsize"
47.Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
48.Fa "locale_t locale"
49.Fc
50.Sh DESCRIPTION
51The
52.Fn wcsftime
53and
54.Fn wcsftime_l
55functions are equivalent to the
56.Fn strftime
57and
58.Fn strftime_l
59functions except for the types of their arguments.
60Refer to
61.Xr strftime 3
62for a detailed description.
63.Pp
64The
65.Fn wcsftime_l
66function takes an explicit
67.Fa locale
68argument, whereas the
69.Fn wcsftime
70function uses the current global or per-thread locale.
71.Sh COMPATIBILITY
72Some early implementations of
73.Fn wcsftime
74had a
75.Fa format
76argument with type
77.Vt "const char *"
78instead of
79.Vt "const wchar_t *" .
80.Sh SEE ALSO
81.Xr strftime 3 ,
82.Xr xlocale 3
83.Sh STANDARDS
84The
85.Fn wcsftime
86function conforms to
87.St -isoC-99 .
88