This documentation is archived and is not being maintained.

Convert::ToByte Method (Object, IFormatProvider)

Converts the value of the specified object to an 8-bit unsigned integer, using the specified culture-specific formatting information.

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

public:
static unsigned char ToByte(
	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::Byte
An 8-bit unsigned integer that is equivalent to value, or zero if value is nullptr.

ExceptionCondition
FormatException

value is not in the property format for a Byte value.

InvalidCastException

value does not implement IConvertible.

-or-

Conversion from value to the Byte type is not supported.

OverflowException

value represents a number that is less than Byte::MinValue or greater than Byte::MaxValue.

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 ByteString class that implements the IConvertible interface. The class stores the string representation of a byte value along with a sign field, so that it is able to represent both signed and unsigned byte values.

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

The following example instantiates several ByteString objects and calls the ToByte(Object, IFormatProvider) method to convert them to byte values. It illustrates that the ToByte(Object, IFormatProvider) method wraps a call to the IConvertible::ToByte method of the object to be converted.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: