Export (0) Print
Expand All

RtlStringCchVPrintfEx function

The RtlStringCchVPrintfExW and RtlStringCchVPrintfExA functions create a character-counted text string, with formatting that is based on supplied formatting information.

Syntax


NTSTATUS RtlStringCchVPrintfEx(
  _Out_      LPTSTR pszDest,
  _In_       size_t cchDest,
  _Out_opt_  LPTSTR *ppszDestEnd,
  _Out_opt_  size_t *pcchRemaining,
  _In_       DWORD dwFlags,
  _In_opt_   LPCTSTR pszFormat,
  _In_       va_list argList
);

Parameters

pszDest [out]

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.

cchDest [in]

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.

ppszDestEnd [out, optional]

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.

pcchRemaining [out, optional]

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.

dwFlags [in]

One or more flags and, optionally, a fill byte. The flags are defined as follows.

ValueMeaning
STRSAFE_FILL_BEHIND_NULL

If set and the function succeeds, the low byte of dwFlags is used to fill the portion of the destination buffer that follows the terminating null character.

STRSAFE_IGNORE_NULLS

If set, either pszDest or pszSrc, or both, can be NULL. NULL pszSrc pointers are treated like empty strings (TEXT("")), which can be copied. NULL pszDest pointers cannot receive nonempty strings.

STRSAFE_FILL_ON_FAILURE

If set and the function fails, the low byte of dwFlags is used to fill the entire destination buffer, and the buffer is null-terminated. This operation overwrites any preexisting buffer contents.

STRSAFE_NULL_ON_FAILURE

If set and the function fails, the destination buffer is set to an empty string (TEXT("")). This operation overwrites any preexisting buffer contents.

STRSAFE_NO_TRUNCATION

If set and the function returns STATUS_BUFFER_OVERFLOW, the contents of the destination buffer are not modified.

 

pszFormat [in, optional]

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.

argList [in]

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.

Return value

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.

Return codeDescription
STATUS_SUCCESS

This success status means source data was present, the output string was created without truncation, and the resultant destination buffer is null-terminated.

STATUS_BUFFER_OVERFLOW

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.

STATUS_INVALID_PARAMETER

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:

  • An invalid flag was specified.
  • The value in cchDest is larger than the maximum buffer size.
  • The destination buffer was already full.
  • A NULL pointer was present without the STRSAFE_IGNORE_NULLS flag.
  • The destination buffer pointer was NULL, but the buffer size was not zero.
  • The destination buffer pointer was NULL, or its length was zero, but a nonzero length source string was present.

 

Remarks

RtlStringCchVPrintfExW and RtlStringCchVPrintfExA should be used instead of the following functions:

  • vsprintf

  • vswprintf

  • _vsnprintf

  • _vsnwprintf

All of these functions accept a format string and its arguments, provided as a va_list-typed argument list, and return a formatted string. RtlStringCchVPrintfExW and RtlStringCchVPrintfExA receive the size, in characters, of the destination buffer to ensure that they do not write past the end of the buffer.

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 typeString literalFunction

WCHAR

L"string"

RtlStringCchVPrintfExW

char

"string"

RtlStringCchVPrintfExA

 

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.

Requirements

Version

Available in Windows XP with Service Pack 1 (SP1) and later versions of Windows.

Header

Ntstrsafe.h (include Ntstrsafe.h)

Library

Ntstrsafe.lib

IRQL

PASSIVE_LEVEL

Unicode and ANSI names

RtlStringCchVPrintfExW (Unicode) and RtlStringCchVPrintfExA (ANSI)

See also

RtlStringCbVPrintfEx
RtlStringCchPrintfEx
RtlStringCchVPrintf

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft