wcsftime (3p) - Linux Manuals

wcsftime: convert date and time to a wide-character string

PROLOG

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

NAME

wcsftime - convert date and time to a wide-character string

SYNOPSIS

#include <wchar.h>

size_t wcsftime(wchar_t *restrict wcs, size_t maxsize,
       const wchar_t *restrict format, const struct tm *restrict timeptr);

DESCRIPTION

The wcsftime() function shall be equivalent to the strftime() 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.

RETURN VALUE

If the total number of resulting wide-character codes including the terminating null wide-character code is no more than maxsize, wcsftime() shall return the number of wide-character codes placed into the array pointed to by wcs, not including the terminating null wide-character code. Otherwise, zero is returned and the contents of the array are unspecified.

ERRORS

No errors are defined.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version 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 .