RtlUnicodeStringCbCopyN function (ntstrsafe.h)

Article
05/02/2024

The RtlUnicodeStringCbCopyN function copies a string from one UNICODE_STRING structure to another while limiting the size of the copied string.

Syntax

NTSTRSAFEDDI RtlUnicodeStringCbCopyN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString,
  [in]  size_t           cbToCopy
);

Parameters

[out] DestinationString

A pointer to a UNICODE_STRING structure that receives the copied string. The string that the SourceString parameter's UNICODE_STRING structure points to is copied to the buffer that the DestinationString parameter's UNICODE_STRING structure points to. The maximum number of bytes in the DestinationString structure's string buffer is NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

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

[in] cbToCopy

The number of bytes to be copied from the source to the destination.

Return value

RtlUnicodeStringCbCopyN returns one of the following NTSTATUS values.

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

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

The contents of the 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.
The cbToCopy parameter's value is greater than NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

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

Remarks

The RtlUnicodeStringCbCopyN function uses the destination buffer's size to ensure that the copy operation does not write past the end of the buffer. The function does not terminate the resultant string with a null character value (that is, with zero).

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 RtlUnicodeStringCbCopyNEx 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