RtlIntPtrToUnicodeString macro (wdm.h)

Article
02/22/2024

The RtlIntPtrToUnicodeString routine converts a specified ULONG_PTR value to a Unicode string that represents the value in a specified base.

Syntax

void RtlIntPtrToUnicodeString(
  [in]            Value,
  [in, optional]  Base,
  [in, out]       String
);

Parameters

[in] Value

Specifies the ULONG_PTR 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

None

Remarks

RtlIntPtrToUnicodeString 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	Desktop
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h, Wudfwdm.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL