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

StringCchVPrintf_l is similar to StringCchVPrintf but includes a parameter for locale information.

Syntax

C++
Copy 

HRESULT StringCchVPrintf_l(
  _Out_ LPTSTR    pszDest,
  _In_  size_t    cchDest,
  _In_  LPCTSTR   pszFormat,
  _In_  _locale_t locale,
  _In_  va_list   argList
);

Parameters

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. For more information, see Format Specification Syntax.

locale [in]

The locale object. For more information, see _create_locale.

argList [in]

The arguments to be inserted into the pszFormat string.

Return value

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 cchDest is either 0 or larger than STRSAFE_MAX_CCH.

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.

 

Remarks

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 StringCchVPrintf_lEx if you require the handling of null string pointer values.

In order to use this function, you must define the following macro in your header file, before including StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header
StrSafe.h

Unicode and ANSI names

StringCchVPrintf_lW (Unicode) and StringCchVPrintf_lA (ANSI)

 

 

Show: