Export (0) Print
Expand All

Convert.ToUInt64 Method (String, Int32)

Converts the string representation of a number in a specified base to an equivalent 64-bit unsigned integer.

This API is not CLS-compliant. 

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<CLSCompliantAttribute(False)> _
Public Shared Function ToUInt64 ( _
	value As String, _
	fromBase As Integer _
) As ULong

Parameters

value
Type: System.String

A string that contains the number to convert.

fromBase
Type: System.Int32

The base of the number in value, which must be 2, 8, 10, or 16.

Return Value

Type: System.UInt64
A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is Nothing.

ExceptionCondition
ArgumentException

fromBase is not 2, 8, 10, or 16.

-or-

value, which represents a non-base 10 unsigned number, is prefixed with a negative sign.

ArgumentOutOfRangeException

value is String.Empty.

FormatException

value contains a character that is not a valid digit in the base specified by fromBase. The exception message indicates that there are no digits to convert if the first character in value is invalid; otherwise, the message indicates that value contains invalid trailing characters.

OverflowException

value, which represents a non-base 10 unsigned number, is prefixed with a negative sign.

-or-

value represents a number that is less than UInt64.MinValue or greater than UInt64.MaxValue.

If fromBase is 16, you can prefix the number specified by the value parameter with "0x" or "0X".

Because the UInt64 data type supports unsigned values only, the ToUInt64(String, Int32) method assumes that value is expressed using unsigned binary representation. In other words, all 64 bits are used to represent the numeric value, and a sign bit is absent. As a result, it is possible to write code in which a signed long integer value that is out of the range of the UInt64 data type is converted to a UInt64 value without the method throwing an exception. The following example converts MinValue to its hexadecimal string representation, and then calls the ToUInt64(String, Int32) method. Instead of throwing an exception, the method displays the message, "0x8000000000000000 converts to 9223372036854775808."

' Create a hexadecimal value out of range of the UInt64 type. 
Dim value As String = Convert.ToString(Long.MinValue, 16)
' Convert it back to a number. 
Try 
   Dim number As UInt64 = Convert.ToUInt64(value, 16)
   Console.WriteLine("0x{0} converts to {1}.", value, number)
Catch e As OverflowException
   Console.WriteLine("Unable to convert '0x{0}' to an unsigned long integer.", _
                     value)
End Try

When performing binary operations or numeric conversions, it is always the responsibility of the developer to verify that a method or operator is using the appropriate numeric representation to interpret a particular value. The following example illustrates one technique for ensuring that the method does not inappropriately use binary representation to interpret a value that uses two's complement representation when converting a hexadecimal string to a UInt64 value. The example determines whether a value represents a signed or an unsigned integer while it is converting that value to its string representation. When the example converts the value to a UInt64 value, it checks whether the original value was a signed integer. If so, and if its high-order bit is set (which indicates that the original value was negative), the method throws an exception.

' Create a negative hexadecimal value out of range of the UInt64 type. 
Dim sourceNumber As Long = Long.MinValue
Dim isSigned As Boolean = Math.Sign(sourceNumber.MinValue) = -1
Dim value As String = Convert.ToString(sourceNumber, 16)
Dim targetNumber As UInt64
Try
   targetNumber = Convert.ToUInt64(value, 16)
   If isSigned And ((targetNumber And &H8000000000000000ul) <> 0) Then 
      Throw New OverflowException()
   Else 
      Console.WriteLine("0x{0} converts to {1}.", value, targetNumber)
   End If     
Catch e As OverflowException
   Console.WriteLine("Unable to convert '0x{0}' to an unsigned long integer.", _
                     value)
End Try  
' Displays the following to the console: 
'    Unable to convert '0x8000' to an unsigned long integer.     

The following example attempts to interpret each element in an array of numeric strings as a hexadecimal value and to convert it to an unsigned long integer.

Module Example
   Public Sub Main()
      Dim hexStrings() As String = { "80000000", "0FFFFFFF", "F0000000", "00A3000", "D", _
                                     "-13", "9AC61", "GAD", "FFFFFFFFFF" }
      For Each hexString As String In hexStrings
         Console.Write("{0,-12}  -->  ", hexString)
         Try 
            Dim number As UInteger = Convert.ToUInt32(hexString, 16)
            Console.WriteLine("{0,18:N0}", number)
         Catch e As FormatException
            Console.WriteLine("{0,18}", "Bad Format")
         Catch e As OverflowException
            Console.WriteLine("{0,18}", "Numeric Overflow")
         Catch e As ArgumentException
            Console.WriteLine("{0,18}", "Invalid in Base 16")
         End Try 
      Next                                             
   End Sub 
End Module 
'    ' The example displays the following output: 
'    80000000      -->       2,147,483,648 
'    0FFFFFFF      -->         268,435,455 
'    F0000000      -->       4,026,531,840 
'    00A3000       -->             667,648 
'    D             -->                  13 
'    -13           -->  Invalid in Base 16 
'    9AC61         -->             633,953 
'    GAD           -->          Bad Format 
'    FFFFFFFFFF    -->    Numeric Overflow

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft