RtlCreateUnicodeString function (ntifs.h)

Article
02/22/2024

The RtlCreateUnicodeString routine creates a new counted Unicode string.

Syntax

NTSYSAPI BOOLEAN RtlCreateUnicodeString(
  [out] PUNICODE_STRING DestinationString,
  [in]  PCWSTR          SourceString
);

Parameters

[out] DestinationString

Pointer to the newly allocated and initialized Unicode string.

[in] SourceString

Pointer to a null-terminated Unicode string with which to initialize the new string.

Return value

RtlCreateUnicodeString returns TRUE if the Unicode string was successfully created, FALSE otherwise.

Remarks

The DestinationString is allocated from paged pool. The caller is responsible for freeing the DestinationString by calling RtlFreeUnicodeString.

For information about other string-handling routines, see the string manipulation functions in Run-Time Library (RTL) Routines.

Requirements

Requirement	Value
Minimum supported client	Windows 2000
Target Platform	Universal
Header	ntifs.h (include Ntifs.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
IRQL	PASSIVE_LEVEL