Convert::ToUInt16 Method (String^)

 

Converts the specified string representation of a number to an equivalent 16-bit unsigned integer.

This API is not CLS-compliant.

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

public:
[CLSCompliantAttribute(false)]
static unsigned short ToUInt16(
	String^ value
)

Parameters

value
Type: System::String^

A string that contains the number to convert.

Return Value

Type: System::UInt16

A 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.

Using the ToUInt16(String^) method is equivalent to passing value to the UInt16::Parse(String^) method. value is interpreted by using the formatting conventions of the current thread culture.

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 attempts to convert each element in a numeric string array to a 16-bit unsigned integer.

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: