RtlStringCchCopyEx function

The RtlStringCchCopyExW and RtlStringCchCopyExA functions copy a character-counted string into a buffer.


NTSTATUS RtlStringCchCopyEx(
  _Out_opt_ LPTSTR  pszDest,
  _In_      size_t  cchDest,
  _In_opt_  LPCTSTR pszSrc,
  _Out_opt_ LPTSTR  *ppszDestEnd,
  _Out_opt_ size_t  *pcchRemaining,
  _In_      DWORD   dwFlags


pszDest [out, optional]

A pointer to a caller-supplied buffer that receives the copied string. The string at pszSrc is copied to the buffer at pszDest and terminated with a null character. The pszDest pointer can be NULL, but only if STRSAFE_IGNORE_NULLS is set in dwFlags.

cchDest [in]

The size of the destination buffer, in characters. The maximum number of characters allowed is NTSTRSAFE_MAX_CCH. If pszDest is NULL, cchDest must be zero.

pszSrc [in, optional]

A pointer to a caller-supplied, null-terminated string. The pszSrc pointer can be NULL, but only if STRSAFE_IGNORE_NULLS is set in dwFlags.

ppszDestEnd [out, optional]

If the caller supplies a non-NULL address pointer, then after the copy operation completes, the function loads that address with a pointer to the destination buffer's resulting null string terminator.

pcchRemaining [out, optional]

If the caller supplies a non-NULL address pointer, the function loads the address with the number of unused characters that are in the buffer pointed to by pszDest, including the terminating null character.

dwFlags [in]

One or more flags and, optionally, a fill byte. The flags are defined as follows:


If set and the function succeeds, the low byte of dwFlags is used to fill the portion of the destination buffer that follows the terminating null character.


If set, either pszDest or pszSrc, or both, can be NULL. NULL pszSrc pointers are treated like empty strings (TEXT("")), which can be copied. NULL pszDest pointers cannot receive nonempty strings.


If set and the function fails, the low byte of dwFlags is used to fill the entire destination buffer, and the buffer is null-terminated. This operation overwrites any preexisting buffer contents.


If set and the function fails, the destination buffer is set to an empty string (TEXT("")). This operation overwrites any preexisting buffer contents.


If set and the function returns STATUS_BUFFER_OVERFLOW, the contents of the destination buffer are not modified.


Return value

The function returns one of the NTSTATUS values that are listed in the following table. For information about how to test NTSTATUS values, see Using NTSTATUS Values.

Return codeDescription

This success status means source data was present, the string was copied without truncation, and the resultant destination buffer is null-terminated.


This warning status means the copy operation did not complete due to insufficient space in the destination buffer. If STRSAFE_NO_TRUNCATION is set in dwFlags, the destination buffer is not modified. If the flag is not set, the destination buffer contains a truncated version of the created string.


This error status means the function received an invalid input parameter. For more information, see the following paragraph.

The function returns the STATUS_INVALID_PARAMETER value when:

  • An invalid flag was specified.
  • The value in cchDest is larger than the maximum buffer size.
  • The destination buffer was already full.
  • A NULL pointer was present without the STRSAFE_IGNORE_NULLS flag.
  • The destination buffer pointer was NULL, but the buffer size was not zero.
  • The destination buffer pointer was NULL, or its length was zero, but a nonzero length source string was present.



RtlStringCchCopyExW and RtlStringCchCopyExA should be used instead of the following functions:

  • strcpy

  • wcscpy

The size, in characters, of the destination buffer is provided to RtlStringCchCopyExW and RtlStringCchCopyExA to ensure that they do not write past the end of the buffer.

RtlStringCchCopyExW and RtlStringCchCopyExA add to the functionality of RtlStringCchCopy by returning a pointer to the end of the destination string, as well as the number of characters left unused in that string. Flags can be passed to the function for additional control. Use RtlStringCchCopyExW to handle Unicode strings and RtlStringCchCopyExA to handle ANSI strings. The form you use depends on your data, as shown in the following table.

String data typeString literalFunction








If pszSrc and pszDest point to overlapping strings, the behavior of the function is undefined.

Neither pszSrc nor pszDest can be NULL unless the STRSAFE_IGNORE_NULLS flag is set, in which case either or both can be NULL. If pszDest is NULL, pszSrc must either be NULL or point to an empty string.

For more information about the safe string functions, see Using Safe String Functions.


Target platform


Available in Windows XP with Service Pack 1 (SP1) and later versions of Windows.


Ntstrsafe.h (include Ntstrsafe.h)





Unicode and ANSI names

RtlStringCchCopyExW (Unicode) and RtlStringCchCopyExA (ANSI)

See also




Send comments about this topic to Microsoft