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

StringCchPrintf_l is similar to StringCchPrintf but includes a parameter for locale information.


HRESULT StringCchPrintf_l(
  _Out_ LPTSTR    pszDest,
  _In_  size_t    cchDest,
  _In_  LPCTSTR   pszFormat,
  _In_  _locale_t locale,
  _In_  ...       


pszDest [out]

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

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.

locale [in]

The locale object. For more information, see _create_locale.


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

There was sufficient space for the result to be copied to pszDest without truncation, and the buffer is null-terminated.


The value in cchDest is either 0 or larger than STRSAFE_MAX_CCH.


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.



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

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


Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]



Unicode and ANSI names

StringCchPrintf_lW (Unicode) and StringCchPrintf_lA (ANSI)



Community Additions