wcsftime Subroutine

Edit online

Purpose

Converts date and time into a wide character string.

Library

Standard C Library (libc. a)

Syntax

#include <time.h>
size_t wcsftime (WcString, Maxsize, Format, TimPtr)
wchar_t * WcString;
size_t  Maxsize;
const wchar_t * Format;
const struct tm * TimPtr;

Description

The wcsftime function is 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.

Parameters

Item Description
WcString Contains the output of the wcsftime subroutine.
Maxsize Specifies the maximum number of bytes (including the wide character null-terminating byte) that may be placed in the WcString parameter.
Format Specifiers are the same as in strftime (strftime Subroutine) function.
TimPtr Contains the data to be converted by the wcsftime subroutine.

Return Values

If successful, and if the number of resulting wide characters (including the wide character null-terminating byte) is no more than the number of bytes specified by the Maxsize parameter, the wcsftime subroutine returns the number of wide characters (not including the wide character null-terminating byte) placed in the WcString parameter. Otherwise, 0 is returned and the contents of the WcString parameter are indeterminate.