Add wcsftime(3).
[dragonfly.git] / lib / libc / locale / wcsftime.3
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: src/lib/libc/locale/wcsftime.3,v 1.2 2002/11/29 17:35:09 ru Exp $
26 .\" $DragonFly: src/lib/libc/locale/wcsftime.3,v 1.1 2005/08/10 13:42:28 joerg Exp $
27 .\"
28 .Dd September 8, 2002
29 .Dt WCSFTIME 3
30 .Os
31 .Sh NAME
32 .Nm wcsftime
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 .Sh DESCRIPTION
44 The
45 .Fn wcsftime
46 function is equivalent to the
47 .Fn strftime
48 function except for the types of its arguments.
49 Refer to
50 .Xr strftime 3
51 for a detailed description.
52 .Sh COMPATIBILITY
53 Some early implementations of
54 .Fn wcsftime
55 had a
56 .Fa format
57 argument with type
58 .Vt "const char *"
59 instead of
60 .Vt "const wchar_t *" .
61 .Sh SEE ALSO
62 .Xr strftime 3
63 .Sh STANDARDS
64 The
65 .Fn wcsftime
66 function conforms to
67 .St -isoC-99 .