The RtlStringCchVPrintfExW and RtlStringCchVPrintfExA functions create a character-counted text string, with formatting that is based on supplied formatting information.
NTSTRSAFEDDI RtlStringCchVPrintfExA( NTSTRSAFE_PSTR pszDest, size_t cchDest, NTSTRSAFE_PSTR *ppszDestEnd, size_t *pcchRemaining, DWORD dwFlags, NTSTRSAFE_PCSTR pszFormat, va_list argList );
A pointer to a caller-supplied buffer that receives a formatted, null-terminated string. The function creates this string from both the formatting string that is supplied by pszFormat and the arguments supplied by argList. The pszDest pointer can be NULL, but only if STRSAFE_IGNORE_NULLS is set in dwFlags.
The size of the destination buffer, in characters. The buffer must be large enough to contain the formatted string plus the terminating null character. The maximum number of characters allowed is NTSTRSAFE_MAX_CCH. If pszDest is NULL, cchDest must be zero.
If the caller supplies a non-NULL address pointer then, after the operation completes, the function loads that address with a pointer to the destination buffer's resulting null string terminator.
If the caller supplies a non-NULL address pointer, the function loads the address with the number of unused bytes that are in the buffer pointed to by pszDest, including those bytes used for the terminating null character.
One or more flags and, optionally, a fill byte. The flags are defined as follows.
Pointer to a null-terminated text string that contains printf-styled formatting directives. The pszFormat pointer can be NULL, but only if STRSAFE_IGNORE_NULLS is set in dwFlags.
A va_list-typed argument list. Arguments contained in the argument list will be interpreted by using the formatting string that is supplied by pszFormat.
The function returns one of the NTSTATUS values that are listed in the following table. For information about how to test NTSTATUS values, see Using NTSTATUS Values.
||This success status means source data was present, the output string was created without truncation, and the resultant destination buffer is null-terminated.|
||This warning status means the operation did not complete due to insufficient space in the destination buffer. If STRSAFE_NO_TRUNCATION is set in dwFlags, the destination buffer is not modified. If the flag is not set, the destination buffer contains a truncated version of the created string.|
This error status means the function received an invalid input parameter. For more information, see the following paragraph.
The function returns the STATUS_INVALID_PARAMETER value when:
RtlStringCchVPrintfExW and RtlStringCchVPrintfExA should be used instead of the following functions:
RtlStringCchVPrintfExW and RtlStringCchVPrintfExA add to the functionality of RtlStringCchVPrintf by returning a pointer to the end of the destination string, as well as the number of characters left unused in that string. Flags can be passed to the function for additional control.
For more information about va_list-typed argument lists, see the Microsoft Windows SDK documentation.
Use RtlStringCchVPrintfExW to handle Unicode strings and RtlStringCchVPrintfExA to handle ANSI strings. The form you use depends on your data.
|String data type||String literal||Function|
If pszDest and pszFormat point to overlapping strings or if any argument strings overlap, the behavior of the function is undefined.
Neither pszSrc nor pszDest can be NULL unless the STRSAFE_IGNORE_NULLS flag is set, in which case either or both can be NULL. If pszDest is NULL, pszSrc must either be NULL or point to an empty string.
For more information about the safe string functions, see Using Safe String Functions.
|Windows version||Available in Windows XP with Service Pack 1 (SP1) and later versions of Windows.|
|Header||ntstrsafe.h (include Ntstrsafe.h)|