xref: /illumos-gate/usr/src/man/man3c/wcsftime.3c (revision 4224453d626325281f3fcd656e646f681b9eca8b)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
Copyright 2025 Bill Sommerfeld

WCSFTIME 3C "May 10, 2025"
NAME
wcsftime, wcsftime_l - convert date and time to wide character string
SYNOPSIS
#include <wchar.h>
"XPG4 and SUS"
size_t wcsftime(wchar_t *wcs, size_t maxsize, const char *format,
 const struct tm *timptr);
"Default and other standards"
size_t wcsftime(wchar_t *restrict wcs, size_t maxsize,
 const wchar_t *restrict format,
 const struct tm *restrict timptr);
size_t wcsftime_l(wchar_t *restrict wcs, size_t maxsize, const wchar_t *restrict format, const struct tm *restrict timptr, locale_t loc);
DESCRIPTION
The wcsftime() function is equivalent to the strftime(3C) function, except that:

The argument wcs points to the initial element of an array of wide-characters into which the generated output is to be placed.

The argument maxsize indicates the maximum number of wide-characters to be placed in the output array.

The argument format is a wide-character string and the conversion specifications are replaced by corresponding sequences of wide-characters.

The return value indicates the number of wide-characters placed in the output array.

If copying takes place between objects that overlap, the behavior is undefined.

Likewise, the wcsftime_l() function is equivalent to the strftime_l(3C), with the same changes as wcsftime.

RETURN VALUES
If the total number of resulting wide character codes (including the terminating null wide-character code) is no more than maxsize, both functions return the number of wide-character codes placed into the array pointed to by wcs, not including the terminating null wide-character code. Otherwise, 0 is returned and the contents of the array are indeterminate.

Both functions may use malloc(3C); should malloc() fail, they will return 0 and errno will be set by malloc().

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability wcsftime: Standard
wcsftime_l: Committed
MT-Level MT-Safe with exceptions
SEE ALSO
malloc (3C), setlocale (3C), strftime (3C), attributes (7), standards (7)
NOTES
The wcsftime() function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale.