Convert.ToUInt32 Method (String, IFormatProvider)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Converts the specified String representation of a number to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.
Assembly: mscorlib (in mscorlib.dll)
'Declaration <CLSCompliantAttribute(False)> _ Public Shared Function ToUInt32 ( _ value As String, _ provider As IFormatProvider _ ) As UInteger
Parameters
- value
- Type: System.String
A String containing a number to convert.
- provider
- Type: System.IFormatProvider
An IFormatProvider interface implementation that supplies culture-specific formatting information.
Return Value
Type: System.UInt32A 32-bit unsigned integer equivalent to the value of value.
-or-
Zero if value is Nothing.
| Exception | Condition |
|---|---|
| FormatException | value does not consist of an optional sign followed by a sequence of digits (zero through nine). |
| OverflowException | value represents a number less than MinValue or greater than MaxValue. |
The return value is the result of invoking UInt32.Parse on value.
provider is an IFormatProvider instance that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is Nothing, the NumberFormatInfo for the current culture is used.
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.
The following code example converts String representations of 32-bit unsigned integers with the ToUInt32 method, using an IFormatProvider object.
' Example of the Convert.ToUInt32( String ) and ' Convert.ToUInt32( String, IFormatProvider ) methods. Imports System.Globalization Module Example Dim format As String = "{0,-22}{1,-20}{2}" ' Get the exception type name; remove the namespace prefix. Function GetExceptionType(ByVal ex As Exception) As String Dim exceptionType As String = ex.GetType().ToString() Return exceptionType.Substring( _ exceptionType.LastIndexOf("."c) + 1) End Function Sub ConvertToUInt32(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal numericStr As String, _ ByVal provider As IFormatProvider) Dim defaultValue As Object Dim providerValue As Object ' Convert numericStr to UInt32 without a format provider. Try defaultValue = Convert.ToUInt32(numericStr) Catch ex As Exception defaultValue = GetExceptionType(ex) End Try ' Convert numericStr to UInt32 with a format provider. Try providerValue = Convert.ToUInt32(numericStr, provider) Catch ex As Exception providerValue = GetExceptionType(ex) End Try outputBlock.Text &= String.Format(format, numericStr, _ defaultValue, providerValue) & vbCrLf End Sub Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock) ' Create a NumberFormatInfo object and set several of its ' properties that apply to numbers. Dim provider As NumberFormatInfo = New NumberFormatInfo() ' These properties affect the conversion. provider.PositiveSign = "pos " provider.NegativeSign = "neg " ' These properties do not affect the conversion. ' The input string cannot have decimal and group separators. provider.NumberDecimalSeparator = "." provider.NumberGroupSeparator = "," provider.NumberGroupSizes = New Integer() {3} outputBlock.Text &= String.Format("This example of" & vbCrLf & _ " Convert.ToUInt32( String ) and " & vbCrLf & _ " Convert.ToUInt32( String, IFormatProvider ) " & _ vbCrLf & "generates the following output. It " & _ "converts several strings to unsigned " & vbCrLf & _ "Integer values, using default formatting " & _ "or a NumberFormatInfo object." & vbCrLf) & vbCrLf outputBlock.Text &= String.Format(format, "String to convert", _ "Default/exception", "Provider/exception") & vbCrLf outputBlock.Text &= String.Format(format, "-----------------", _ "-----------------", "------------------") & vbCrLf ' Convert strings, with and without an IFormatProvider. ConvertToUInt32(outputBlock, "123456789", provider) ConvertToUInt32(outputBlock, "+123456789", provider) ConvertToUInt32(outputBlock, "pos 123456789", provider) ConvertToUInt32(outputBlock, "123456789.", provider) ConvertToUInt32(outputBlock, "123,456,789", provider) ConvertToUInt32(outputBlock, "4294967295", provider) ConvertToUInt32(outputBlock, "4294967296", provider) ConvertToUInt32(outputBlock, "-1", provider) End Sub End Module ' This example of ' Convert.ToUInt32( String ) and ' Convert.ToUInt32( String, IFormatProvider ) ' generates the following output. It converts several strings to unsigned ' Integer values, using default formatting or a NumberFormatInfo object. ' ' String to convert Default/exception Provider/exception ' ----------------- ----------------- ------------------ ' 123456789 123456789 123456789 ' +123456789 123456789 FormatException ' pos 123456789 FormatException 123456789 ' 123456789. FormatException FormatException ' 123,456,789 FormatException FormatException ' 4294967295 4294967295 4294967295 ' 4294967296 OverflowException OverflowException ' -1 OverflowException FormatException