Export (0) Print
Expand All

UInt32.TryParse Method (String, UInt32)

Tries to convert the string representation of a number to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed.

This API is not CLS-compliant. The CLS-compliant alternative is TryParse.

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

'Declaration
<CLSCompliantAttribute(False)> _
Public Shared Function TryParse ( _
	s As String, _
	<OutAttribute> ByRef result As UInteger _
) As Boolean

Parameters

s
Type: System.String

A string that represents the number to convert.

result
Type: System.UInt32

When this method returns, contains the 32-bit unsigned integer value that is equivalent to the number contained in s, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the s parameter is Nothing or String.Empty, is not of the correct format, or represents a number that is less than UInt32.MinValue or greater than UInt32.MaxValue. This parameter is passed uninitialized.

Return Value

Type: System.Boolean
true if s was converted successfully; otherwise, false.

The TryParse method is like the Parse method, except that it does not throw an exception if the conversion fails. This method eliminates the need to use exception handling to test for a FormatException if s is invalid and cannot be successfully parsed.

The s parameter should be the string representation of a decimal number in the following form:

[ws][sign]digits[ws]

Elements in square brackets ([ and ]) are optional. The following table describes each element.

Element

Description

ws

Optional white space.

sign

An optional sign. Valid sign characters are determined by the NumberFormatInfo.NegativeSign and NumberFormatInfo.PositiveSign properties of the current culture.

digits

A sequence of decimal digits ranging from 0 to 9.

The s parameter is interpreted by using the NumberStyles.Integer style. In addition to the decimal digits, only leading and trailing spaces with a leading sign are allowed. To explicitly define the style elements with the culture-specific formatting information that can be present in s, call the TryParse(String, NumberStyles, IFormatProvider, UInt32) method.

NoteNote

The string specified by the s parameter cannot contain any group separators or decimal separator, and it cannot have a fractional portion.

The s parameter is parsed by using the formatting information in a NumberFormatInfo object for the current system culture. For more information, see NumberFormatInfo.CurrentInfo.

This overload interprets all digits in the s parameter as decimal digits. To parse the string representation of a hexadecimal number, call the TryParse(String, NumberStyles, IFormatProvider, UInt32) overload instead.

The following example calls the TryParse(String, UInt32) method once for each element in a string array.

Dim numericStrings() As String = {"1293.8", "+1671.7", "28347.", 
                                  "   33113684  ", "(0)", "-0", "-1",
                                  "+1293617", "18-", "119870", 
                                  "31,024", "  3127094 ", "0070000" }
Dim number As UInteger 
For Each numericString As String In numericStrings
   If UInt32.TryParse(numericString, number) Then
      Console.WriteLine("Converted '{0}' to {1}.", numericString, number)
   Else
      Console.WriteLine("Cannot convert '{0}' to a UInt32.", numericString)
   End If       
Next 
' The example displays the following output: 
'       Cannot convert '1293.8' to a UInt32. 
'       Cannot convert '+1671.7' to a UInt32. 
'       Cannot convert '28347.' to a UInt32. 
'       Converted '   33113684  ' to 33113684. 
'       Cannot convert '(0)' to a UInt32. 
'       Converted '-0' to 0. 
'       Cannot convert '-1' to a UInt32. 
'       Converted '+1293617' to 1293617. 
'       Cannot convert '18-' to a UInt32. 
'       Converted '119870' to 119870. 
'       Cannot convert '31,024' to a UInt32. 
'       Converted '  3127094 ' to 3127094. 
'       Converted '0070000' to 70000.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.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