RtlInitUnicodeString

The RtlInitUnicodeString routine initializes a counted Unicode string.

VOID 
  RtlInitUnicodeString(
    IN OUT PUNICODE_STRING  DestinationString,
    IN PCWSTR  SourceString
    );

Parameters

DestinationString

Pointer to the UNICODE_STRING structure to be initialized.

SourceString

Pointer to a zero-terminated Unicode string with which to initialize the counted string.

Return Value

None

Headers

Declared in wdm.h and ntddk.h. Include wdm.h or ntddk.h.

Comments

The Buffer member of DestinationString is initialized to point to SourceString. The length and maximum length for DestinationString are initialized to the length of SourceString. If SourceString is NULL, the length is zero.

Callers of RtlInitUnicodeString can be running at IRQL <= DISPATCH_LEVEL if the DestinationString buffer is nonpageable. Usually, callers run at IRQL = PASSIVE_LEVEL because most other RtlXxxString routines cannot be called at raised IRQL.

See Also

RtlInitAnsiString, RtlInitString, UNICODE_STRING