Parse(System.String,System.Globalization.NumberStyles,System.IFormatProvider)

Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent.

Syntax

public static short Parse (string s, System.Globalization.NumberStyles style, IFormatProvider provider)

Parameters

s
A string containing a number to convert.
style
A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
s
A string containing a number to convert.
style
A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer.
provider
An IFormatProvider that supplies culture-specific formatting information about s.

Returns

A 16-bit signed integer equivalent to the number specified in s.

Exceptions

Type Reason
ArgumentNullException s is a null reference.
FormatException s is not in the correct style.
OverflowException s represents a number greater than short.MaxValue or less than short.MinValue.

Type	Reason
ArgumentNullException	s is a null reference.
FormatException	s is not in the correct style.
OverflowException	s represents a number greater than short.MaxValue or less than short.MinValue.

Remarks

The style parameter defines the style elements (such as white space or the positive sign) that are allowed in the s parameter for the parse operation to succeed. It must be a combination of bit flags from the System.Globalization.NumberStyles enumeration. Depending on the value of style, the s parameter may include the following elements:

[ws][$][sign][digits,]digits[.fractional_digits][e[sign]digits][ws]

Or, if style includes System.Globalization.NumberStyles.AllowHexSpecifier:

[ws]hexdigits[ws]

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


ws	Optional white space. White space can appear at the beginning of s if style includes the System.Globalization.NumberStyles.AllowLeadingWhite flag, or at the end of s if style includes the System.Globalization.NumberStyles.AllowTrailingWhite flag.
$	A culture-specific currency symbol. Its position in the string is defined by the System.Globalization.NumberFormatInfo.CurrencyPositivePattern and System.Globalization.NumberFormatInfo.CurrencyNegativePattern property of the current culture. The current culture's currency symbol can appear in s if style includes the System.Globalization.NumberStyles.AllowCurrencySymbol flag.
sign	An optional sign. The sign can appear at the beginning of s if style includes the System.Globalization.NumberStyles.AllowLeadingSign flag, and it can appear at the end of s if style includes the System.Globalization.NumberStyles.AllowTrailingSign flag. Parentheses can be used in s to indicate a negative value if style includes the System.Globalization.NumberStyles.AllowParentheses flag.
digits	A sequence of digits from 0 through 9.
,	A culture-specific thousands separator symbol. The current culture's thousands separator symbol can appear in s if style includes the System.Globalization.NumberStyles.AllowThousands flag.
.	A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the System.Globalization.NumberStyles.AllowDecimalPoint flag.
fractional_digits	A sequence of the 0 digit. Fractional digits can appear in s if style includes the System.Globalization.NumberStyles.AllowDecimalPoint flag. If any digit other than 0 appears in fractional_digits, the method throws an OverflowException.
e	The 'e' or 'E' character, which indicates that s can be represented in exponential notation. The s parameter can represent a number in exponential notation if style includes the System.Globalization.NumberStyles.AllowExponent flag. However, the s parameter must represent a number in the range of the short data type and cannot have a non-zero fractional component.
hexdigits	A sequence of hexadecimal digits from 0 through f, or 0 through F.

A string with digits only (which corresponds to the System.Globalization.NumberStyles.None style) always parses successfully. Most of the remaining System.Globalization.NumberStyles members control elements that may be but are not required to be present in this input string. The following table indicates how individual System.Globalization.NumberStyles members affect the elements that may be present in s.


System.Globalization.NumberStyles.None	Decimal digits only.
System.Globalization.NumberStyles.AllowDecimalPoint	The . and fractional_digits elements. However, fractional_digits must consist of only one or more 0 digits or an OverflowException is thrown.
System.Globalization.NumberStyles.AllowExponent	The s parameter can also use exponential notation.
System.Globalization.NumberStyles.AllowLeadingWhite	The ws element at the beginning of s.
System.Globalization.NumberStyles.AllowTrailingWhite	The ws element at the end of s.
System.Globalization.NumberStyles.AllowLeadingSign	A sign can appear before digits.
System.Globalization.NumberStyles.AllowTrailingSign	A sign can appear after digits.
System.Globalization.NumberStyles.AllowParentheses	The sign element in the form of parentheses enclosing the numeric value.
System.Globalization.NumberStyles.AllowThousands	The , element.
System.Globalization.NumberStyles.AllowCurrencySymbol	The $ element.

If the System.Globalization.NumberStyles.AllowHexSpecifier flag is used, s must be the string representation of a hexadecimal value. The only other flags that can be present in style are System.Globalization.NumberStyles.AllowLeadingWhite and System.Globalization.NumberStyles.AllowTrailingWhite. (The System.Globalization.NumberStyles enumeration has a composite number style, System.Globalization.NumberStyles.HexNumber, that includes both white space flags.)

The provider parameter is an IFormatProvider implementation whose IFormatProvider.GetFormat(Type) method obtains a System.Globalization.NumberFormatInfo object. The System.Globalization.NumberFormatInfo object provides culture-specific information about the format of s. If provider is null, the System.Globalization.NumberFormatInfo object for the current culture is used.

Requirements

Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0