StringCbVPrintf

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/27/2008

This function is a replacement for vsprintf.

It accepts a format string and its arguments, provided as a va_list, and returns a formatted string.

The size, in bytes, of the destination buffer is provided to the function to ensure that StringCbVPrintf does not write past the end of this buffer.

Syntax

HRESULT StringCbVPrintf(      
    LPTSTR pszDest,
    size_t cbDest,
    LPCTSTR pszFormat,
    va_list argList
);

Parameters

• pszDest
  [out] Pointer to a buffer that receives the formatted, null-terminated string created from pszFormat and argList.

• cbDest
  [in] Size of the destination buffer, in bytes.

  This value must be sufficiently large to accommodate the final formatted string plus the terminating null character.

  The maximum number of bytes allowed is STRSAFE_MAX_CCH * sizeof(TCHAR).

• pszFormat
  [in] Pointer to a buffer containing a printf-style format string.

  This string must be null-terminated.

• argList
  [in] A va_list containing the arguments to be inserted into pszFormat.

Return Value

This function returns an HRESULT, as opposed to vsprintf, which returns the number of characters written.

It is strongly recommended that you use the SUCCEEDED and FAILED macros to test the return value of this function.

Value	Description
S_OK	There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated.
STRSAFE_E_INVALID_PARAMETER	The value in cbDest is 0 or larger than STRSAFE_MAX_CCH * sizeof(TCHAR).
STRSAFE_E_INSUFFICIENT_BUFFER	The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. Where truncation is acceptable, this is not necessarily a failure condition.

Remarks

StringCbVPrintf provides additional processing for proper buffer handling in your code.

Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCbVPrintf always null-terminates a nonzero-length destination buffer.

For more information on va_lists, see the conventions defined in Stdarg.h.

StringCbVPrintf can be used in its generic form, or specifically as StringCbVPrintfA (for ANSI strings) or StringCbVPrintfW (for Unicode strings). The form to use is determined by your data.

String data type	String literal	Function
char	"string"	StringCbVPrintfA
TCHAR	TEXT("string")	StringCbVPrintf
WCHAR	L"string"	StringCbVPrintfW

StringCbVPrintf and its ANSI and Unicode variants are replacements for these functions:

• vsprintf
• vswprintf
• wvsprintf
• _vsnprintf
• _vsnwprintf

If the strings pointed to by pszDest, pszFormat, or any argument strings overlap, behavior is undefined.

Neither pszFormat nor pszDest should be NULL.

If you need the handling of null string pointer values, see StringCbVPrintfEx.

Requirements

Header	strsafe.h
Windows Embedded CE	Windows CE 5.0 and later

See Also

Reference

StringCchVPrintf
StringCbVPrintfEx
StringCbPrintf