This topic has not yet been rated - Rate this topic

Convert.ToUInt32 Method (String)

.NET Framework 4

Other Versions

Updated: March 2012

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

This API is not CLS-compliant.

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

Syntax

C++

Copy

[CLSCompliantAttribute(false)]
public static uint ToUInt32(
	string value
)

Parameters

value: Type: System.String
A string that contains the number to convert.

Return Value

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

Exceptions

Exception	Condition
FormatException	value does not consist of an optional sign followed by a sequence of digits (0 through 9).
OverflowException	value represents a number that is less than UInt32.MinValue or greater than UInt32.MaxValue.

Remarks

Using the ToUInt32 method is equivalent to passing value to the UInt32.Parse(String) method. value is interpreted by using the formatting conventions of the current thread culture.

If you prefer not to handle an exception if the conversion fails, you can call the UInt32.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

Examples

The following example interprets the elements in a string array as numeric strings and attempts to convert them to unsigned integers.

Copy


string[] values = { "One", "1.34e28", "-26.87", "-18", "-6.00",
                    " 0", "137", "1601.9", Int32.MaxValue.ToString() };
uint result;

foreach (string value in values)
{
   try {
      result = Convert.ToUInt32(value);
      Console.WriteLine("Converted the {0} value '{1}' to the {2} value {3}.",
                        value.GetType().Name, value, 
                        result.GetType().Name, result);
   }
   catch (OverflowException) {
      Console.WriteLine("The {0} value '{1}' is outside the range of the UInt32 type.",
                        value.GetType().Name, value);
   }   
   catch (FormatException) {
      Console.WriteLine("The {0} value '{1}' is not in a recognizable format.",
                        value.GetType().Name, value);
   }   
}                                 
// The example displays the following output:
//    The String value 'One' is not in a recognizable format.
//    The String value '1.34e28' is not in a recognizable format.
//    The String value '-26.87' is not in a recognizable format.
//    The String value '-18' is outside the range of the UInt32 type.
//    The String value '-6.00' is not in a recognizable format.
//    Converted the String value ' 0' to the UInt32 value 0.
//    Converted the String value '137' to the UInt32 value 137.
//    The String value '1601.9' is not in a recognizable format.
//    Converted the String value '2147483647' to the UInt32 value 2147483647.

Version Information

.NET Framework

Supported in: 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

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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