WCSFTIME(3) NEWLIB WCSFTIME(3)NAME
7.13 `wcsftime'-convert date and time to a formatted wide-character
string
SYNOPSIS
#include <time.h>
#include <wchar.h>
size_t wcsftime(wchar_t *S, size_t MAXSIZE,
const wchar_t *FORMAT, const struct tm *TIMP);
DESCRIPTION
`wcsftime' is equivalent to `strftime', except that:
* The argument s 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 limiting number of wide
characters.
* The argument format is a wide-character string and the conversion
specifiers are replaced by corresponding sequences of wide
characters.
* The return value indicates the number of wide characters.
(The difference in all of the above being wide characters versus
regular characters.) See `strftime' for the details of the format
specifiers.
RETURNS
When the formatted time takes up no more than MAXSIZE wide characters,
the result is the length of the formatted wide string. Otherwise, if
the formatting operation was abandoned due to lack of room, the result
is `0', and the wide-character string starting at S corresponds to just
those parts of `*FORMAT' that could be completely filled in within the
MAXSIZE limit.
PORTABILITY
C99 and POSIX require `wcsftime', but do not specify the contents of
`*S' when the formatted string would require more than MAXSIZE charac‐
ters. Unrecognized specifiers and fields of `timp' that are out of
range cause undefined results. Since some formats expand to 0 bytes,
it is wise to set `*S' to a nonzero value beforehand to distinguish
between failure and an empty string. This implementation does not sup‐
port `s' being NULL, nor overlapping `s' and `format'.
`wcsftime' requires no supporting OS subroutines.
*See Also*
`strftime'
SEE ALSOwcsftime is part of the library. The full documentation for is main‐
tained as a Texinfo manual. If info and are properly installed at your
site, the command
info
will give you access to the complete manual.
NEWLIB April 2010 WCSFTIME(3)
