Edit

Share via

RtlUnicodeStringCopy function (ntstrsafe.h)

  • Article

The RtlUnicodeStringCopy function copies a string from one UNICODE_STRING structure to another.

Syntax

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

Parameters

[out] DestinationString

A pointer to a UNICODE_STRING structure. The source string is copied to the destination string. The maximum number of bytes in the structure's string buffer is NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

A pointer to a UNICODE_STRING structure. This structure includes a buffer that contains the source string. This string will be copied to the destination string. The maximum number of bytes in the structure's string buffer is NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Return value

RtlUnicodeStringCopy 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 version of the source string.
STATUS_INVALID_PARAMETER
 This error status means that the function received an invalid input parameter. For more information, see the following list.
 

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

  • The contents of a UNICODE_STRING structure are invalid.
  • The destination buffer 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 RtlUnicodeStringCopy function uses the destination buffer's size to ensure that the copy operation does not write past the end of the buffer. If the string must be truncated at the end of the destination buffer, the function does not terminate the resultant string with a null character.

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

The SourceString and DestinationString pointers cannot be NULL. If you need to handle NULL pointer values, use the RtlUnicodeStringCopyEx 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

See also

RtlUnicodeStringCopyEx

UNICODE_STRING