The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Convert::ToSingle Method (Object^, IFormatProvider^)

.NET Framework (current version)

Other Versions

Converts the value of the specified object to an single-precision floating-point number, using the specified culture-specific formatting information.

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

Syntax

C++

public:
static float ToSingle(
	Object^ value,
	IFormatProvider^ provider
)

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::Single

A single-precision floating-point number that is equivalent to value, or zero if value is null.

Exceptions

Exception	Condition
FormatException	value is not in an appropriate format.
InvalidCastException	value does not implement IConvertible.
OverflowException	value represents a number that is less than Single::MinValue or greater than Single::MaxValue.

Remarks

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

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.

Examples

The following example defines a Temperature class that implements the IConvertible interface. Its implementation of the IConvertible::ToSingle method returns the internal value of a private Single variable that represents the temperature.

C++

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

The following example illustrates how a call to the Convert::ToSingle(Object^, IFormatProvider^) method, in turn, calls the IConvertible::ToSingle implementation of the Temperature class.

C++