Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer.
StringCbPrintfEx adds to the functionality of StringCbPrintf by returning a pointer to the end of the destination string as well as the number of bytes left unused in that string. Flags may also be passed to the function for additional control.
StringCbPrintfEx is a replacement for the following functions:
HRESULT StringCbPrintfEx( _Out_ LPTSTR pszDest, _In_ size_t cbDest, _Out_opt_ LPTSTR *ppszDestEnd, _Out_opt_ size_t *pcbRemaining, _In_ DWORD dwFlags, _In_ LPCTSTR pszFormat, _In_ ... );
- pszDest [out]
The destination buffer, which receives the formatted, null-terminated string created from pszFormat and its arguments.
- cbDest [in]
The 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).
- ppszDestEnd [out, optional]
The address of a pointer to the end of pszDest. If ppszDestEnd is non-NULL and any data is copied into the destination buffer, this points to the terminating null character at the end of the string.
- pcbRemaining [out, optional]
The number of unused bytes in pszDest, including those used for the terminating null character. If pcbRemaining is NULL, the count is not kept or returned.
- dwFlags [in]
One or more of the following values.
- pszFormat [in]
The format string. This string must be null-terminated.
- ... [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 cbDest is either 0 or larger than
The copy operation failed due to insufficient buffer space. Depending on the value of dwFlags, the destination buffer may contain 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.
Compared to the functions it replaces, StringCbPrintfEx provides additional processing for proper buffer handling in your code. Poor buffer handling is implicated in many security issues that involve buffer overruns. StringCbPrintfEx always null-terminates a nonzero-length destination buffer.
Behavior is undefined if the strings pointed to by pszDest, pszFormat, or any argument strings overlap.
Neither pszFormat nor pszDest should be NULL unless the STRSAFE_IGNORE_NULLS flag is specified, in which case both may be NULL. However, an error due to insufficient space may still be returned even though NULL values are ignored.
StringCbPrintfEx 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.
|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
|StringCbPrintfExW (Unicode) and StringCbPrintfExA (ANSI)|