ToUInt16 Method

2013-01-16

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Shared Function ToUInt16 ( _
    value As String _
) As UShort

[CLSCompliantAttribute(false)]
public static ushort ToUInt16(
    string value
)

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

[<CLSCompliantAttribute(false)>]
static member ToUInt16 : 
        value:string -> uint16

public static function ToUInt16(
    value : String
) : ushort

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 nullNothingnullptrunita null reference (Nothing in Visual Basic).

Exceptions

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.

Remarks

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.

Share via