ToByte Method (String, IFormatProvider)

Convert.ToByte Method (String, IFormatProvider)

Converts the specified String representation of a number to an equivalent 8-bit signed integer using specified culture-specific formatting information.

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

public static byte ToByte (
	string value,
	IFormatProvider provider
)
public static byte ToByte (
	String value, 
	IFormatProvider provider
)
public static function ToByte (
	value : String, 
	provider : IFormatProvider
) : byte
Not applicable.

Parameters

value

A String containing a number to convert.

provider

An IFormatProvider interface implementation that supplies culture-specific formatting information.

Return Value

An 8-bit signed integer equivalent to the value of value. -or- Zero if value is a null reference (Nothing in Visual Basic).

Exception typeCondition

FormatException

value does not consist of an optional sign followed by a sequence of digits (zero through nine).

OverflowException

value represents a number less than MinValue or greater than MaxValue.

provider is an IFormatProvider instance that obtains a NumberFormatInfo object. The NumberFormatInfo object provides culture-specific information about the format of value. If provider is a null reference (Nothing in Visual Basic), the NumberFormatInfo for the current culture is used.

The following code example converts String representations of unsigned Byte values with the ToByte method, using an IFormatProvider object.

// Example of the Convert.ToByte( string ) and 
// Convert.ToByte( string, IFormatProvider ) methods.
using System;
using System.Globalization;

class ToByteProviderDemo
{
    static string format = "{0,-20}{1,-20}{2}";

     // Get the exception type name; remove the namespace prefix.
    static string GetExceptionType( Exception ex )
    {
        string exceptionType = ex.GetType( ).ToString( );
        return exceptionType.Substring( 
            exceptionType.LastIndexOf( '.' ) + 1 );
    }

    static void ConvertToByte( string numericStr, 
        IFormatProvider provider )
    {
        object defaultValue;
        object providerValue;

        // Convert numericStr to Byte without a format provider.
        try
        {
            defaultValue = Convert.ToByte( numericStr );
        }
        catch( Exception ex )
        {
            defaultValue = GetExceptionType( ex );
        }

        // Convert numericStr to Byte with a format provider.
        try
        {
            providerValue = Convert.ToByte( numericStr, provider );
        }
        catch( Exception ex )
        {
            providerValue = GetExceptionType( ex );
        }

        Console.WriteLine( format, numericStr, 
            defaultValue, providerValue );
    }

    public static void Main( )
    {
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider = new NumberFormatInfo();

        // These properties affect the conversion.
        provider.NegativeSign = "neg ";
        provider.PositiveSign = "pos ";

        // These properties do not affect the conversion.
        // The input string cannot have decimal and group separators.
        provider.NumberDecimalSeparator = ".";

        Console.WriteLine("This example of\n" +
            "  Convert.ToByte( string ) and \n" +
            "  Convert.ToByte( string, IFormatProvider ) " +
            "\ngenerates the following output. It converts " +
            "several strings to \nbyte values, using " +
            "default formatting or a NumberFormatInfo object.\n" );
        Console.WriteLine( format, "String to convert", 
            "Default/exception", "Provider/exception" );
        Console.WriteLine( format, "-----------------", 
            "-----------------", "------------------" );

        // Convert strings, with and without an IFormatProvider.
        ConvertToByte( "234", provider );
        ConvertToByte( "+234", provider );
        ConvertToByte( "pos 234", provider );
        ConvertToByte( "234.", provider );
        ConvertToByte( "255", provider );
        ConvertToByte( "256", provider );
        ConvertToByte( "-1", provider );
    }
}

/*
This example of
  Convert.ToByte( string ) and
  Convert.ToByte( string, IFormatProvider )
generates the following output. It converts several strings to
byte values, using default formatting or a NumberFormatInfo object.

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
234                 234                 234
+234                234                 FormatException
pos 234             FormatException     234
234.                FormatException     FormatException
255                 255                 255
256                 OverflowException   OverflowException
-1                  OverflowException   FormatException
*/ 

// Example of the Convert.ToByte( string ) and 
// Convert.ToByte( string, IFormatProvider ) methods.
import System.* ;
import System.Globalization.* ;

class ToByteProviderDemo
{
   private static String format = "{0,-20}{1,-20}{2}";   
   
   // Get the exception type name; remove the namespace prefix.
    static String GetExceptionType(System.Exception ex) 
    {
        String exceptionType = ex.GetType().ToString();
        return exceptionType.Substring((exceptionType.LastIndexOf('.') + 1)) ;
    } //GetExceptionType   
   
    static void ConvertToByte(String numericStr, IFormatProvider provider)
    {
        Object defaultValue;
        Object providerValue;

        // Convert numericStr to Byte without a format provider.
        try {
            defaultValue = (System.Byte)Convert.ToByte(numericStr);
        }
        catch (System.Exception ex)    {
            defaultValue = GetExceptionType(ex);
        }

        // Convert numericStr to Byte with a format provider.
        try    {
            providerValue = (System.Byte)Convert.ToByte(numericStr, provider);
            //providerValue =  (numericStr, provider);
        }
        catch (System.Exception ex)    {
            providerValue = GetExceptionType(ex);
        }
        Console.WriteLine(format, numericStr, defaultValue, providerValue);
    } //ConvertToByte   
   
    public static void main(String[] args)
    {
        // Create a NumberFormatInfo object and set several of its
        // properties that apply to numbers.
        NumberFormatInfo provider = new NumberFormatInfo();

        // These properties affect the conversion.
        provider.set_NegativeSign("neg ");
        provider.set_PositiveSign("pos ");

        // These properties do not affect the conversion.
        // The input string cannot have decimal and group separators.
        provider.set_NumberDecimalSeparator(".");
        Console.WriteLine(("This example of\n" 
            + "  Convert.ToByte( string ) and \n" 
            + "  Convert.ToByte( string, IFormatProvider ) " 
            + "\ngenerates the following output. It converts " 
            + "several strings to \nbyte values, using " 
            + "default formatting or a NumberFormatInfo object.\n"));
        Console.WriteLine(format, "String to convert", "Default/exception",
            "Provider/exception");
        Console.WriteLine(format, "-----------------", "-----------------",
            "------------------");

        // Convert strings, with and without an IFormatProvider.
        ConvertToByte("234", provider);
        ConvertToByte("+234", provider);
        ConvertToByte("pos 234", provider);
        ConvertToByte("234.", provider);
        ConvertToByte("255", provider);
        ConvertToByte("256", provider);
        ConvertToByte("-1", provider);
    } //main
} //ToByteProviderDemo

/*
This example of
  Convert.ToByte( string ) and
  Convert.ToByte( string, IFormatProvider )
generates the following output. It converts several strings to
byte values, using default formatting or a NumberFormatInfo object.

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
234                 234                 234
+234                234                 FormatException
pos 234             FormatException     234
234.                FormatException     FormatException
255                 255                 255
256                 OverflowException   OverflowException
-1                  OverflowException   FormatException
*/

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2016 Microsoft