RtlCharToInteger routine

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

Syntax


NTSTATUS RtlCharToInteger(
  _In_     PCSZ   String,
  _In_opt_ ULONG  Base,
  _Out_    PULONG Value
);

Parameters

String [in]

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

Base [in, optional]

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.

Value [out]

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

Target platform

Universal

Version

Available starting with Windows 2000.

Header

Ntddk.h (include Ntddk.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

PASSIVE_LEVEL

See also

RtlInitString
RtlIntegerToUnicodeString

 

 

Send comments about this topic to Microsoft

Show: