RtlCharToInteger function (ntddk.h)

Article
02/22/2024

The RtlCharToInteger routine converts a single-byte character string to an integer value in the specified base.

Syntax

NTSYSAPI NTSTATUS RtlCharToInteger(
  [in]           PCSZ   String,
  [in, optional] ULONG  Base,
  [out]          PULONG Value
);

Parameters

[in] String

Pointer to a null-terminated, single-byte character string.

[in, optional] Base

Specifies decimal, binary, octal, or hexadecimal base. If this parameter is not given, the routine will look for 0x, 0o, and 0b prefixes in the input string to determine if the base should be decimal (default), binary, octal, or hexadecimal.

[out] Value

Pointer to a location to which the converted value is returned.

Return value

RtlCharToInteger returns STATUS_SUCCESS if the given character string is converted. Otherwise, it can return STATUS_INVALID_PARAMETER.

Remarks

RtlCharToInteger converts ANSI alphanumeric characters.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 2000.
Target Platform	Universal
Header	ntddk.h (include Ntddk.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL