ValUInt

FreeBASIC

ValUInt
 
Converts a string to an unsigned 32bit integer

Syntax

Declare Function ValUInt ( ByRef strnum As Const String ) As Ulong
Declare Function ValUInt ( ByRef strnum As Const WString ) As Ulong

Usage

result = ValUInt ( strnum )

Parameters

strnum
the string to convert

Return Value

Returns a Ulong value of the converted string

If the first character of the string is invalid, ValUInt will return 0.

Description

For example, ValUInt("10") will return 10, and ValUInt("10.60") will return 10 as well. The function parses the string from the left, skipping any white space, and returns the longest number it can read, stopping at the first non-suitable character it finds. Any non-numeric characters, including decimal points and exponent specifiers, are considered non-suitable, for example, ValUInt("23.1E+6") will just return 23.

ValUInt can be used to convert integer numbers in Binary / Octal / Hexadecimal format, if they have the relevant identifier ("&B;" / "&O;" / "&H;") prefixed, for example: ValUInt("&HFF;") returns 255.

If you want to convert a number into string format, use the Str function.

Example

Dim a As String, b As UInteger
a = "20xa211"
b = ValUInt(a)
Print a, b


20xa211   20


Dialect Differences

  • Not available in the -lang qb dialect unless referenced with the alias __Valuint.

Differences from QB

  • New to FreeBASIC

See also