Writes formatted data to the specified string using a pointer to a list of arguments. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer.
StringCchVPrintf is a replacement for the following functions:
HRESULT StringCchVPrintf( _Out_ LPTSTR pszDest, _In_ size_t cchDest, _In_ LPCTSTR pszFormat, _In_ va_list argList );
- pszDest [out]
The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList.
- cchDest [in]
The size of the destination buffer, in characters. This value must be sufficiently large to accommodate the final formatted string plus 1 to account for the terminating null character. The maximum number of characters allowed is STRSAFE_MAX_CCH.
- pszFormat [in]
The format string. This string must be null-terminated.
- argList [in]
The arguments to be inserted into the pszFormat string.
There was sufficient space for the result to be copied to pszDest without truncation and the buffer is null-terminated.
The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH.
The copy operation failed due to insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result. In situations where truncation is acceptable, this may not necessarily be seen as a failure condition.
Note that this function returns an HRESULT value, unlike the functions that it replaces.
StringCchVPrintf provides additional processing for proper buffer handling in your code. Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCchVPrintf always null-terminates a nonzero-length destination buffer.
For more information on va_lists, see the conventions defined in Stdarg.h.
Behavior is undefined if the strings pointed to by pszDest, pszFormat, or any argument strings overlap.
Neither pszFormat nor pszDest should be NULL. See StringCchVPrintfEx if you require the handling of null string pointer values.
StringCchVPrintf can be used in its generic form, or in its more specific forms. The data type of the string determines the form of this function that you should use, as shown in the following table.
|String Data Type||String Literal||Function|
Minimum supported client
|Windows XP with SP2 [desktop apps | Windows Store apps]|
Minimum supported server
|Windows Server 2003 with SP1 [desktop apps | Windows Store apps]|
Unicode and ANSI names
|StringCchVPrintfW (Unicode) and StringCchVPrintfA (ANSI)|
Build date: 11/16/2013