Convert.ToInt16 Method (Object, IFormatProvider)
Converts the value of the specified object to a 16-bit signed integer, using the specified culture-specific formatting information.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
-
Type:
System.Object
An object that implements the IConvertible interface.
- provider
-
Type:
System.IFormatProvider
An object that supplies culture-specific formatting information.
Return Value
Type: System.Int16A 16-bit signed integer that is equivalent to value, or zero if value is null.
| Exception | Condition |
|---|---|
| FormatException | value is not in an appropriate format for an Int16 type. |
| InvalidCastException | value does not implement IConvertible. |
| OverflowException | value represents a number that is less than Int16.MinValue or greater than Int16.MaxValue. |
provider enables the user to specify culture-specific conversion information about the contents of value. For example, if value is a String that represents a number, provider could supply culture-specific information about the notation used to represent that number.
The base types ignore provider; however, the parameter may be used if value is a user-defined type that implements the IConvertible interface.
The following example defines a class that implements IConvertible and a class that implements IFormatProvider. Objects of the class that implements IConvertible hold an array of Double values. An object of each class is passed to the ToInt16 method. This method returns an average of the array of Double values, using the object that implements IFormatProvider to determine how to calculate the average.
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