RtlStringCchCopyUnicodeString function (ntstrsafe.h)

Article
12/09/2021

The RtlStringCchCopyUnicodeString function copies the contents of a UNICODE_STRING structure to a specified destination.

Syntax

NTSTRSAFEDDI RtlStringCchCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  PCUNICODE_STRING SourceString
);

Parameters

[out] pszDest

A pointer to a buffer that receives the copied string. The string that the SourceString parameter's UNICODE_STRING structure points to is copied to the buffer at pszDest and terminated with a null character.

[in] cchDest

The size, in characters, of the destination buffer. The buffer must be large enough for the string and the terminating null character. The maximum number of characters is NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] SourceString

A pointer to a UNICODE_STRING structure that contains the string to be copied. The maximum number of characters in the string is NTSTRSAFE_UNICODE_STRING_MAX_CCH.

Return value

RtlStringCchCopyUnicodeString returns one of the following NTSTATUS values.

Return code	Description
STATUS_SUCCESS	This success status means that source data was present, the string was copied without truncation, and the resultant destination buffer is null-terminated.
STATUS_BUFFER_OVERFLOW	This warning status means that the copy operation did not complete because of insufficient buffer space. The destination buffer contains a truncated, null-terminated version of the intended result.
STATUS_INVALID_PARAMETER	This error status means that the function received an invalid input parameter. For more information, see the following list.

RtlStringCchCopyUnicodeString returns the STATUS_INVALID_PARAMETER value when one of the following occurs:

The contents of the UNICODE_STRING structure are invalid.
The value in cbDest is larger than the maximum buffer size.
The destination buffer (which pszDest points to) is already full.
A buffer pointer is NULL.
The destination buffer's length is zero, but a nonzero length source string is present.

For information about how to test NTSTATUS values, see Using NTSTATUS Values.

Remarks

The RtlStringCchCopyUnicodeString function uses the destination buffer's size (which cchDest specifies) to ensure that the copy operation does not write past the end of the buffer.

If the source and destination strings overlap, the behavior of the function is undefined.

The SourceString and pszDest pointers cannot be NULL. If you need to handle NULL pointer values, use the RtlStringCchCopyUnicodeStringEx function.

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

Requirements

Requirement	Value
Minimum supported client	Available in Windows XP with Service Pack 1 (SP1) and later versions of Windows.
Target Platform	Desktop
Header	ntstrsafe.h (include Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL	Any if strings being manipulated are always resident in memory, otherwise PASSIVE_LEVEL