RtlDuplicateUnicodeString(3w)

RtlDuplicateUnicodeString3w

Usage

NTSTATUS RtlDuplicateUnicodeString
(
int add_nul,
const UNICODE_STRING* source,
UNICODE_STRING* destination
)

Params

add_nul [In] flag.

source [In] Unicode string to be duplicated.

destination [Out] destination for the duplicated unicode string.

Overview

Duplicates a unicode string.

Returns

Success: STATUS_SUCCESS. destination contains the duplicated unicode string.

Failure: STATUS_INVALID_PARAMETER, if one of the parameters is illegal. STATUS_NO_MEMORY, if the allocation fails.

Notes

For add_nul there are several possible values: 0 = destination will not be ' ' terminated, 1 = destination will be ' ' terminated, 3 = like 1 but for an empty source string produce ' ' terminated empty Buffer instead of assigning NULL to the Buffer. Other add_nul values are invalid.

Implementation

Declared in "winternl.h".

Implemented in "dlls/ntdll/rtlstr.c".

Debug channel "ntdll".

Releases

4 releases since Debian 4.0 (Etch); the text changed 3 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7

From libwine-dev 1.4.1-4 in Debian 7 (Wheezy). Parsed by carta from the page's man source.