Edit

Share via

RtlIntegerToUnicodeString function (wdm.h)

  • Article

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

Syntax

NTSYSAPI NTSTATUS RtlIntegerToUnicodeString(
  [in]           ULONG           Value,
  [in, optional] ULONG           Base,
  [in, out]      PUNICODE_STRING String
);

Parameters

[in] Value

Specifies the ULONG value to convert.

[in, optional] Base

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

Value Base
16 Hexadecimal
8 Octal
2 Binary
0 or 10 Decimal

[in, out] String

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 code Description
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

Requirement Value
Minimum supported client Available starting with Windows 2000.
Target Platform Universal
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h, Wudfwdm.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe (kernel mode); Ntdll.dll (user mode)
IRQL PASSIVE_LEVEL

See also

RtlAppendUnicodeStringToString

RtlUnicodeStringToInteger

UNICODE_STRING