This documentation is archived and is not being maintained.

Convert::ToSByte Method (Object, IFormatProvider)

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

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
public:
static signed char ToSByte(
	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::SByte
An 8-bit signed integer that is equivalent to value, or zero if value is nullptr.

ExceptionCondition
FormatException

value is not in an appropriate format.

InvalidCastException

value does not implement the IConvertible interface.

-or-

The conversion is not supported.

OverflowException

value represents a number that is less than SByte::MinValue or greater than SByte::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 ByteString class that stores both signed and unsigned bytes as hexadecimal strings along with a field that indicates the sign of the byte. The ByteString class implements the IConvertible interface. Its IConvertible::ToSByte method calls the Parse(String, IFormatProvider) method to perform the conversion. If it fails, it throws an OverflowException.

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

The following example shows how the IConvertible::ToSByte implementation of the ByteString class is called by the Convert::ToSByte(Object, IFormatProvider) method.

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: