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

^[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to the ISO C standard.

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.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

strftime(), the Base Definitions volume of IEEE Std 1003.1-2001, <wchar.h>

CHANGE HISTORY

First released in Issue 4.

Issue 5

Moved from ENHANCED I18N to BASE and the [ENOSYS] error is removed.

Aligned with ISO/IEC 9899:1990/Amendment 1:1995 (E). Specifically, the type of the format argument is changed from const char * to const wchar_t *.

Issue 6

The wcsftime() prototype is updated for alignment with the ISO/IEC 9899:1999 standard.