vwsprintf Subroutine

Purpose

Writes formatted wide characters.

Library

Standard C Library (libc.a)

Syntax

#include <wchar.h>
#include <stdarg.h>

int vwsprintf (wcs, Format, arg) wchar_t * wcs; const char * Format; va_list arg;

Description

The vwsprintf subroutine writes formatted wide characters. It is structured like the vsprintf subroutine with a few differences. One difference is that the wcs parameter specifies a wide character array into which the generated output is to be written, rather than a character array. The second difference is that the meaning of the S conversion specifier is always the same in the case where the # flag is specified. If copying takes place between objects that overlap, the behavior is undefined.

Note: The programmer must ensure that there is room for at least maxlen wide characters at wcs.

Parameters

Item	Description
wcs	Specifies the array of wide characters where the output is to be written.
Format	Specifies a multibyte character sequence composed of zero or more directives (ordinary multibyte characters and conversion specifiers). The new formats added to handle the wide characters are: %C Formats a single wide character. %S Formats a wide character string.
arg	Specifies the parameters to be printed.

Return Values

The vwsprintf subroutine returns the number of wide characters (not including the terminating wide character null) written into the wide character array and specified by the wcs parameter.