Expand Minimize

RtlIntegerToUnicodeString routine

The RtlIntegerToUnicodeString routine converts an unsigned integer value to a null-terminated string of one or more Unicode characters in the specified base.

Syntax


NTSTATUS RtlIntegerToUnicodeString(
  _In_      ULONG Value,
  _In_opt_  ULONG Base,
  _Inout_   PUNICODE_STRING String
);

Parameters

Value [in]

Specifies the ULONG value to convert.

Base [in, optional]

Specifies the base to use when converting Value to a string. The possible values are:

ValueBase

16

Hexadecimal

8

Octal

2

Binary

0 or 10

Decimal

 

String [in, out]

Pointer to a UNICODE_STRING structure that receives the string representation of Value. The buffer specified by the Buffer of String must be large enough to hold the result.

Return value

RtlIntegerToUnicodeString returns an NTSTATUS value. Possible return values include:

Return codeDescription
STATUS_SUCCESS

The routine successfully converted Value to a Unicode string.

STATUS_BUFFER_OVERFLOW

Value is too large to convert, or the UNICODE_STRING structure is too small to hold the result.

STATUS_INVALID_PARAMETER

The specified code base is not valid. The only valid values are 0, 2, 8, 10, and 16.

 

Requirements

Version

Available starting with Windows 2000.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

Ntoskrnl.lib

IRQL

PASSIVE_LEVEL

See also

RtlUnicodeStringToInteger
RtlAppendUnicodeStringToString
UNICODE_STRING

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft