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

.SH NAME
\fBRtlUnicodeStringToInteger\fR (NTDLL.@)
.SH SYNOPSIS
NTSTATUS RtlUnicodeStringToInteger
 (
  const UNICODE_STRING* \fIstr\fR,
  ULONG                 \fIbase\fR,
  ULONG*                \fIvalue\fR
 )

.SH PARAMS
\fIstr\fR \fB[In]\fR  Unicode string to be converted.
.PP
\fIbase\fR \fB[In]\fR  Number \fIbase\fR for conversion (allowed \fB0\fR,2,8,10 or \fB16\fR).
.PP
\fIvalue\fR \fB[Out]\fR  Destination for the converted \fIvalue\fR.
.PP

.SH DESCRIPTION
.PP
Converts a unicode string into its integer equivalent. 

.SH RETURNS
.PP
\fBSuccess:\fR \fBSTATUS_SUCCESS\fR. \fIvalue\fR contains the converted number 
.PP
\fBFailure:\fR \fBSTATUS_INVALID_PARAMETER\fR, if \fIbase\fR is not \fB0\fR, \fB2\fR, \fB8\fR, \fB10\fR or \fB16.\fR \fBSTATUS_ACCESS_VIOLATION\fR, if \fIvalue\fR is \fBNULL\fR. 

.SH NOTES
.PP
For \fIbase\fR \fB0\fR it uses \fB10\fR as \fIbase\fR and the string should be in the format \fB"{whitespace} [+|-] [0[x|o|b]] {digits}"\fR. For other bases the string should be in the format \fB"{whitespace} [+|-] {digits}"\fR. No check is made for \fIvalue\fR overflow, only the lower \fB32\fR bits are assigned. If \fIstr\fR is \fBNULL\fR it crashes, as the native function does. 

.SH DIFFERENCES
.PP
This function does not read garbage on string length \fB0\fR as the native version does. 

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