Export (0) Print
Expand All

Int16.Parse Method (String, NumberStyles)

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

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

public static short Parse (
	string s,
	NumberStyles style
)
public static short Parse (
	String s, 
	NumberStyles style
)
public static function Parse (
	s : String, 
	style : NumberStyles
) : short
Not applicable.

Parameters

s

A string containing a number to convert.

style

A bitwise combination of NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is NumberStyles.Integer.

Return Value

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

Exception typeCondition

ArgumentNullException

s is a null reference (Nothing in Visual Basic).

ArgumentException

style is not a NumberStyles value.

-or-

style is not a combination of AllowHexSpecifier and HexNumber values.

FormatException

s is not in a format compliant with style.

OverflowException

s represents a number less than MinValue or greater than MaxValue.

The style parameter defines the style elements (such as white space or a 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.

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

Or, if style includes AllowHexSpecifier:

[ws]hexdigits[ws]

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

Element

Description

ws

Optional white space. White space can appear at the beginning of s if style includes the NumberStyles.AllowLeadingWhite flag, or 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 NumberFormatInfo.CurrencyPositivePattern and NumberFormatInfo.CurrencyNegativePattern property of the current culture. The current culture's currency symbol can appear in s if style includes the NumberStyles.AllowCurrencySymbol flag.

sign

An optional sign. The sign can appear at the beginning of s if style includes the NumberStyles.AllowLeadingSign flag, and it can appear at 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.

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 NumberStyles.AllowThousands flag.

.

A culture-specific decimal point symbol. The current culture's decimal point symbol can appear in s if style includes the NumberStyles.AllowDecimalPoint flag.

fractional-digits

A sequence of the 0 digit. Fractional digits can appear in s if style includes the System.Globalization.AllowDecimalPoint flag. If any digit other than 0 appears in fractional-digits, the method throws a 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 sign element following e must either be a positive sign or it must be omitted, or the method throws an OverflowException.

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 NumberStyles members control elements that may be 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

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. If s represents a number in exponential notation, the exponent's sign can be present only if it is positive. In addition, s must represent an integer within the range of the Int16 data type.

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 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 NumberStyles.AllowLeadingWhite and NumberStyles.AllowTrailingWhite. (The NumberStyles enumeration has a composite number style, NumberStyles.HexNumber, that includes both white space flags.)

The s parameter is parsed using the formatting information in a NumberFormatInfo object initialized for the current system culture. For more information, see NumberFormatInfo.CurrentInfo. To parse s using the formatting information of a specific culture, call the Int16.Parse(String,NumberStyles,IFormatProvider) method.

The following example uses the Int16.Parse(String,NumberStyles) method to parse the string representations of Int16 values using the en-US culture.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft