StringCbPrintf_lA function

Writes formatted data to the specified string. The size of the destination buffer is provided to the function to ensure that it does not write past the end of this buffer.

StringCbPrintf_l is similar to StringCbPrintf but includes a parameter for locale information.

Syntax

STRSAFEAPI StringCbPrintf_lA(
  STRSAFE_LPSTR                                  pszDest,
  size_t                                         cbDest,
  _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  _locale_t                                      locale,
  ...                                            
);

Parameters

pszDest

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

cbDest

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

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

locale

The locale object. For more information, see _create_locale.

arg5

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

Remarks

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

Neither pszFormat nor pszDest should be NULL. See StringCbPrintf_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 | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header strsafe.h