Convert.ToUInt16 Method (String, IFormatProvider)
Converts the specified string representation of a number to an equivalent 16-bit unsigned integer, using the specified culture-specific formatting information.
This API is not CLS-compliant.
Assembly: mscorlib (in mscorlib.dll)
[<CLSCompliantAttribute(false)>] static member ToUInt16 : value:string * provider:IFormatProvider -> uint16
Parameters
- value
-
Type:
System.String
A string that contains the number to convert.
- provider
-
Type:
System.IFormatProvider
An object that supplies culture-specific formatting information.
Return Value
Type: System.UInt16A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null.
| 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 UInt16.MinValue or greater than UInt16.MaxValue. |
The return value is the result of invoking UInt16.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 null, the NumberFormatInfo for the current culture is used.
If you prefer not to handle an exception if the conversion fails, you can call the UInt16.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.
The following example defines a custom NumberFormatInfo object that recognizes the string "pos" as the positive sign and the string "neg" as the negative sign. It then attempts to convert each element of a numeric string array to an integer using both this provider and the NumberFormatInfo provider for the invariant culture.
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1