nf-strsafe-stringcbvprintf_lexw.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:strsafe.StringCbVPrintf_lExW	StringCbVPrintf_lExW function (strsafe.h)	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_lExW)	STRSAFE_FILL_BEHIND_NULL STRSAFE_FILL_ON_FAILURE STRSAFE_IGNORE_NULLS STRSAFE_NO_TRUNCATION STRSAFE_NULL_ON_FAILURE StringCbVPrintf_lEx StringCbVPrintf_lEx function [Menus and Other Resources] StringCbVPrintf_lExW menurc.stringcbvprintf_lex strsafe/StringCbVPrintf_lEx strsafe/StringCbVPrintf_lExW	menurc\stringcbvprintf_lex.htm	menurc	34db0546-cede-4329-8364-137bca118755	12/05/2018	STRSAFE_FILL_BEHIND_NULL, STRSAFE_FILL_ON_FAILURE, STRSAFE_IGNORE_NULLS, STRSAFE_NO_TRUNCATION, STRSAFE_NULL_ON_FAILURE, StringCbVPrintf_lEx, StringCbVPrintf_lEx function [Menus and Other Resources], StringCbVPrintf_lExA, StringCbVPrintf_lExW, menurc.stringcbvprintf_lex, strsafe/StringCbVPrintf_lEx, strsafe/StringCbVPrintf_lExA, strsafe/StringCbVPrintf_lExW	strsafe.h		Windows	Windows Vista [desktop apps \| UWP apps]	Windows Server 2008 [desktop apps \| UWP apps]				StringCbVPrintf_lExW (Unicode) and StringCbVPrintf_lExA (ANSI)									Windows			19H1	StringCbVPrintf_lExW strsafe/StringCbVPrintf_lExW	c++	APIRef kbSyntax	HeaderDef	StrSafe.h	StringCbVPrintf_lEx StringCbVPrintf_lExA StringCbVPrintf_lExW

StringCbVPrintf_lExW function

-description

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_lEx is similar to StringCbVPrintfEx but includes a parameter for locale information.

-parameters

-param pszDest [out]

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

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

-param ppszDestEnd [out]

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.

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

-param dwFlags [in]

One or more of the following values.

Value	Meaning
STRSAFE_FILL_BEHIND_NULL 0x00000200	If the function succeeds, the low byte of dwFlags (0) is used to fill the uninitialized portion of pszDest following the terminating null character.
STRSAFE_IGNORE_NULLS 0x00000100	Treat NULL string pointers like empty strings (TEXT("")).
STRSAFE_FILL_ON_FAILURE 0x00000400	If the function fails, the low byte of dwFlags (0) is used to fill the entire pszDest buffer, and the buffer is null-terminated. In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string returned is overwritten.
STRSAFE_NULL_ON_FAILURE 0x00000800	If the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten.
STRSAFE_NO_TRUNCATION 0x00001000	As in the case of STRSAFE_NULL_ON_FAILURE, if the function fails, pszDest is set to an empty string (TEXT("")). In the case of a STRSAFE_E_INSUFFICIENT_BUFFER failure, any truncated string is overwritten.

-param pszFormat [in]

The format string. This string must be null-terminated. For more information, see Format Specification Syntax.

-param locale [in]

The locale object. For more information, see _create_locale.

-param argList [in]

The arguments to be inserted into the pszFormat string.

-returns

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 code	Description
S_OK	There is 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), or the destination buffer is already full.
STRSAFE_E_INSUFFICIENT_BUFFER	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.

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

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

#define STRSAFE_LOCALE_FUNCTIONS

Note

The strsafe.h header defines StringCbVPrintf_lEx as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.