wvsprintf
The wvsprintf
function formats and stores a series of characters and values in a buffer. The
items pointed to by the argument list are converted and copied to an output
buffer according to the corresponding format specification in the
format-control string. The function appends a terminating null character to the
characters it writes, but the return value does not include the terminating
null character in its character count.
int wvsprintf(
|
LPTSTR lpOutput, |
// pointer to
buffer for output |
|
LPCTSTR lpFormat, |
// pointer to
format-control string |
|
va_list arglist |
// variable
argument list of format-control arguments |
|
); |
|
Parameters
lpOutput
Points to a
buffer to receive the formatted output.
lpFormat
Points to a
null-terminated string that contains the format-control specifications. In
addition to ordinary ASCII characters, a format specification for each argument
appears in this string. For more information about the format specification,
see the wsprintf
function.
arglist
A variable
argument list; each element of the list specifies an argument for the
format-control string. The number, type, and interpretation of the arguments
depend on the corresponding format-control specifications in the lpFmt
parameter.
Return Values
If the
function succeeds, the return value is the number of characters stored in the
buffer, not counting the terminating null character.
If the
function fails, the return value is less than the length of the format-control
string. To get extended error information, call GetLastError.
Remarks
The function
copies the format-control string into the output buffer character by character,
starting with the first character in the string. When it encounters a format
specification in the string, the function retrieves the value of the next
available argument (starting with the first argument in the list), converts
that value into the specified format, and copies the result to the output
buffer. The function continues to copy characters and expand format specifications
in this way until it reaches the end of the format-control string. If there are
more arguments than format specifications, the extra arguments are ignored. If
there are not enough arguments for all of the format specifications, the
results are undefined.
See Also