Convert.ToChar Method (Object, IFormatProvider)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Converts the value of the specified object to its equivalent Unicode character, using the specified culture-specific formatting information.

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

static member ToChar : 
        value:Object *
        provider:IFormatProvider -> char

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

A Unicode character that is equivalent to value, or Char.MinValue if value is null.

Exception Condition
ArgumentNullException

value is a null string.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion of value to a Char is not supported.

OverflowException

value is less than Char.MinValue or greater than Char.MaxValue.

The return value is the result of invoking the IConvertible.ToChar method of the underlying type of value.

provider enables the user to specify culture-specific conversion information about the contents of value. 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 ToChar method. This method returns a character whose Unicode value is the average of the array of Double values, using the object that implements IFormatProvider to determine how to calculate the average.

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: