UInt16::Parse Method (String^, IFormatProvider^)

 
clsCompliantAlternativeM:System.Int32.Parse(System.String)

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

This API is not CLS-compliant.

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

public:
[CLSCompliantAttribute(false)]
static unsigned short Parse(
	String^ s,
	IFormatProvider^ provider
)

Parameters

s
Type: System::String^

A string that represents the number to convert.

provider
Type: System::IFormatProvider^

An object that supplies culture-specific formatting information about s.

Return Value

Type: System::UInt16

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

Exception Condition
ArgumentNullException

s is null.

FormatException

s is not in the correct format.

OverflowException

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

The s parameter contains a number of the form:

[ws][sign]digits[ws]

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

Element

Description

ws

Optional white space.

sign

An optional sign, or a negative sign if s represents the value zero.

digits

A sequence of digits ranging from 0 to 9.

The s parameter is interpreted using the NumberStyles::Integer style. In addition to the byte value's decimal digits, only leading and trailing spaces along with a leading sign is allowed. (If the negative sign is present, s must represent a value of zero or the method throws an OverflowException.) To explicitly define the style elements together with the culture-specific formatting information that can be present in s, use the Parse(String^, NumberStyles, IFormatProvider^) method.

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:

  • You can pass the actual NumberFormatInfo object that provides formatting information. (Its implementation of GetFormat simply returns itself.)

  • You can pass a CultureInfo object that specifies the culture whose formatting is to be used. Its NumberFormat property provides formatting information.

  • You can pass a custom IFormatProvider implementation. Its GetFormat method must instantiate and return the NumberFormatInfo object that provides formatting information.

If provider is null, the NumberFormatInfo for the current culture is used.

The following example instantiates a custom culture that uses two plus signs (++) as its positive sign. It then calls the Parse(String^, IFormatProvider^) method to parse an array of strings by using CultureInfo objects that represent both this custom culture and the invariant culture.

No code example is currently available or this language may not be supported.

Universal Windows Platform
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
Return to top
Show: