UInt16::Parse Method (String, NumberStyles, IFormatProvider)
Converts the string representation of a number in a specified style and culture-specific format to its 16-bit unsigned integer equivalent.
This API is not CLS-compliant. The CLS-compliant alternative is Parse. Namespace: System
Assembly: mscorlib (in mscorlib.dll)
[CLSCompliantAttribute(false)] public: static unsigned short Parse( String^ s, NumberStyles style, IFormatProvider^ provider )
- Type: System::String
A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter.
- Type: System.Globalization::NumberStyles
A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is NumberStyles::Integer.
- Type: System::IFormatProvider
An object that supplies culture-specific formatting information about s.
Return ValueType: System::UInt16
A 16-bit unsigned integer equivalent to the number specified in s.
s is nullptr.
style is not a NumberStyles value.
s is not in a format compliant with style.
s includes non-zero, fractional digits.
The style parameter defines the style elements (such as white space or the positive or negative sign symbol) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the NumberStyles enumeration.
Depending on the value of style, the s parameter may include the following elements:
Elements in square brackets ([ and ]) are optional. If style includes NumberStyles::AllowHexSpecifier, the s parameter may include the following elements:
The following table describes each element.
Optional white space. White space can appear at the beginning of s if style includes the NumberStyles::AllowLeadingWhite flag, and it can appear at the end of s if style includes the NumberStyles::AllowTrailingWhite flag.
A culture-specific currency symbol. Its position in the string is defined by the CurrencyPositivePattern property of the NumberFormatInfo object that is returned by the GetFormat method of the provider parameter. The currency symbol can appear in s if style includes the NumberStyles::AllowCurrencySymbol flag.
An optional sign. (The method throws an OverflowException if s includes a negative sign and represents a non-zero number.) The sign can appear at the beginning of s if style includes the NumberStyles::AllowLeadingSign flag, and it can appear the end of s if style includes the NumberStyles::AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the NumberStyles::AllowParentheses flag.
A sequence of digits from 0 through 9.
A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the NumberStyles::AllowDecimalPoint flag.
One or more occurrences of the digit 0-9 if style includes the NumberStyles::AllowExponent flag, or one or more occurrences of the digit 0 if it does not. Fractional digits can appear in s only if style includes the NumberStyles::AllowDecimalPoint flag.
The "e" or "E" character, which indicates that the value is represented in exponential (scientific) notation. The s parameter can represent a number in exponential notation if style includes the NumberStyles::AllowExponent flag.
A sequence of digits from 0 through 9. The s parameter can represent a number in exponential notation if style includes the NumberStyles::AllowExponent flag.
A sequence of hexadecimal digits from 0 through f, or 0 through F.
A string with decimal digits only (which corresponds to the NumberStyles::None style) always parses successfully. Most of the remaining NumberStyles members control elements that may be present, but are not required to be present, in this input string. The following table indicates how individual NumberStyles members affect the elements that may be present in s.
Non-composite NumberStyles values
Elements permitted in s in addition to digits
Decimal digits only.
The decimal point (.) and fractional_digits elements. However, if style does not include the NumberStyles::AllowExponent flag, fractional_digits must consist of only one or more 0 digits; otherwise, an OverflowException is thrown.
The "e" or "E" character, which indicates exponential notation, along with exponential_digits.
The ws element at the beginning of s.
The ws element at the end of s.
A sign before digits.
A sign after digits.
Parentheses before and after digits to indicate a negative value.
The group separator (,) element.
The currency ($) element.
If the NumberStyles::AllowHexSpecifier flag is used, s must be a hexadecimal value. Valid hexadecimal digits are 0 through 9, a through f, and A through F. A prefix, such as "0x", is not supported and causes the parse operation to fail. The only other flags that can be combined with NumberStyles::AllowHexSpecifier are NumberStyles::AllowLeadingWhite and NumberStyles::AllowTrailingWhite. (The NumberStyles enumeration includes a composite number style, NumberStyles::HexNumber, that includes both white-space flags.)
If the s parameter is the string representation of a hexadecimal number, it cannot be preceded by any decoration (such as 0x or &h) that differentiates it as a hexadecimal number. This causes the parse operation to throw an exception.
The provider parameter is an IFormatProvider implementation whose GetFormat method returns a NumberFormatInfo object that provides culture-specific information about the format of s. There are three ways to use the provider parameter to supply custom formatting information to the parse operation:
If provider is nullptr, the NumberFormatInfo object for the current culture is used.
.NET FrameworkSupported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
XNA FrameworkSupported in: 3.0, 2.0, 1.0
Portable Class LibrarySupported in: Portable Class Library
Supported in: Windows Phone 8.1
Supported in: Windows Phone Silverlight 8.1
Supported in: Windows Phone Silverlight 8