xref: /dflybsd-src/lib/libc/locale/wcsftime.3 (revision 7d3de48c6627bb72c991c76cd5d8a010211db77a)

.\" 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: head/lib/libc/locale/wcsftime.3 107392 2002-11-29 17:35:09Z ru $
.\"
.Dd December 26, 2013
.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" "size_t maxsize"
.Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
.Fc
.In xlocale.h
.Ft size_t
.Fo wcsftime_l
.Fa "wchar_t * restrict wcs" "size_t maxsize"
.Fa "const wchar_t * restrict format" "const struct tm * restrict timeptr"
.Fa "locale_t locale"
.Fc
.Sh DESCRIPTION
The
.Fn wcsftime
and
.Fn wcsftime_l
functions are equivalent to the
.Fn strftime
and
.Fn strftime_l
functions except for the types of their arguments.
Refer to
.Xr strftime 3
for a detailed description.
.Pp
The
.Fn wcsftime_l
function takes an explicit
.Fa locale
argument, whereas the
.Fn wcsftime
function uses the current global or per-thread locale.
.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 .