.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH RtlDuplicateUnicodeString 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBRtlDuplicateUnicodeString\fR (NTDLL.@)
.SH SYNOPSIS
NTSTATUS RtlDuplicateUnicodeString
 (
  int                   \fIadd_nul\fR,
  const UNICODE_STRING* \fIsource\fR,
  UNICODE_STRING*       \fIdestination\fR
 )

.SH PARAMS
\fIadd_nul\fR \fB[In]\fR  flag.
.PP
\fIsource\fR \fB[In]\fR  Unicode string to be duplicated.
.PP
\fIdestination\fR \fB[Out]\fR  \fIdestination\fR for the duplicated unicode string.
.PP

.SH DESCRIPTION
.PP
Duplicates a unicode string. 

.SH RETURNS
.PP
\fBSuccess:\fR \fBSTATUS_SUCCESS\fR. \fIdestination\fR contains the duplicated unicode string. 
.PP
\fBFailure:\fR \fBSTATUS_INVALID_PARAMETER\fR, if one of the parameters is illegal. \fBSTATUS_NO_MEMORY\fR, if the allocation fails. 

.SH NOTES
.PP
For \fIadd_nul\fR there are several possible values: 0 = \fIdestination\fR will not be \fB'\0'\fR terminated, 1 = \fIdestination\fR will be \fB'\0'\fR terminated, 3 = like \fB1\fR but for an empty \fIsource\fR string produce \fB'\0'\fR terminated empty Buffer instead of assigning \fBNULL\fR to the Buffer. Other \fIadd_nul\fR values are invalid. 

.SH IMPLEMENTATION
.PP
Declared in \fB"winternl.h"\fR. 
.PP
Implemented in \fB"dlls/ntdll/rtlstr.c"\fR. 
.PP
Debug channel \fB"ntdll"\fR.