Export (0) Print
Expand All

StringCbVPrintf function

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.

StringCbVPrintf is a replacement for the following functions:

Syntax


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

Parameters

pszDest [out]

Type: LPTSTR

The destination buffer, which receives the formatted, null-terminated string created from pszFormat and argList.

cbDest [in]

Type: size_t

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).

pszFormat [in]

Type: LPCTSTR

The format string. This string must be null-terminated.

argList [in]

Type: va_list

The arguments to be inserted into the pszFormat string.

Return value

Type: HRESULT

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

Return codeDescription
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 either 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. 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.

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.

Behavior is undefined if the strings pointed to by pszDest, pszFormat, or any argument strings overlap.

Neither pszFormat nor pszDest should be NULL. See StringCbVPrintfEx if you require the handling of null string pointer values.

StringCbVPrintf 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 TypeString LiteralFunction
char"string"StringCbVPrintfA
TCHARTEXT("string")StringCbVPrintf
WCHARL"string"StringCbVPrintfW

 

Requirements

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]

Header

Strsafe.h

Unicode and ANSI names

StringCbVPrintfW (Unicode) and StringCbVPrintfA (ANSI)

See also

Reference
StringCchVPrintf
StringCbVPrintfEx
StringCbPrintf

 

 

Community Additions

ADD
Show:
© 2014 Microsoft