Export (0) Print
Expand All

Convert.ToUInt16 Method (String, IFormatProvider)

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

This method is not CLS-compliant.  

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

[CLSCompliantAttribute(false)] 
public static ushort ToUInt16 (
	string value,
	IFormatProvider provider
)
/** @attribute CLSCompliantAttribute(false) */ 
public static UInt16 ToUInt16 (
	String value, 
	IFormatProvider provider
)
CLSCompliantAttribute(false) 
public static function ToUInt16 (
	value : String, 
	provider : IFormatProvider
) : ushort

Parameters

value

A String containing a number to convert.

provider

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

Return Value

A 16-bit unsigned 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.

The return value is the result of invoking UInt16.Parse on value.

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 16-bit unsigned integers with the ToUInt16 method, using an IFormatProvider object.

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

class ToUInt16ProviderDemo
{
    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 ConvertToUInt16( string numericStr, 
        IFormatProvider provider )
    {
        object defaultValue;
        object providerValue;

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

        // Convert numericStr to UInt16 with a format provider.
        try
        {
            providerValue = Convert.ToUInt16( 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 = ".";
        provider.NumberGroupSeparator = ",";
        provider.NumberGroupSizes = new int[ ] { 3 };

        Console.WriteLine("This example of\n" +
            "  Convert.ToUInt16( string ) and \n" +
            "  Convert.ToUInt16( string, IFormatProvider ) " +
            "\ngenerates the following output. It converts " +
            "several strings to \nushort 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.
        ConvertToUInt16( "34567", provider );
        ConvertToUInt16( "+34567", provider );
        ConvertToUInt16( "pos 34567", provider );
        ConvertToUInt16( "34567.", provider );
        ConvertToUInt16( "34,567", provider );
        ConvertToUInt16( "65535", provider );
        ConvertToUInt16( "65536", provider );
        ConvertToUInt16( "-1", provider );
    }
}

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

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
34567               34567               34567
+34567              34567               FormatException
pos 34567           FormatException     34567
34567.              FormatException     FormatException
34,567              FormatException     FormatException
65535               65535               65535
65536               OverflowException   OverflowException
-1                  OverflowException   FormatException
*/ 

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

class ToUInt16ProviderDemo
{
    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 ConvertToUInt16(String numericStr, IFormatProvider provider)
    {
        Object defaultValue;
        Object providerValue;

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

        // Convert numericStr to UInt16 with a format provider.
        try    {
            providerValue = Convert.ToUInt16(numericStr, provider);
        }
        catch (System.Exception ex)    {
            providerValue = GetExceptionType(ex);
        }
        Console.WriteLine(format, numericStr, defaultValue, providerValue);
    } //ConvertToUInt16   
   
    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(".");
        provider.set_NumberGroupSeparator(",");
        provider.set_NumberGroupSizes(new int[] { 3 });
        Console.WriteLine(("This example of\n"
            + "  Convert.ToUInt16( string ) and \n" 
            + "  Convert.ToUInt16( string, IFormatProvider ) " 
            + "\ngenerates the following output. It converts " 
            + "several strings to \nushort 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.
        ConvertToUInt16("34567", provider);
        ConvertToUInt16("+34567", provider);
        ConvertToUInt16("pos 34567", provider);
        ConvertToUInt16("34567.", provider);
        ConvertToUInt16("34,567", provider);
        ConvertToUInt16("65535", provider);
        ConvertToUInt16("65536", provider);
        ConvertToUInt16("-1", provider);
    } //main
} //ToUInt16ProviderDemo

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

String to convert   Default/exception   Provider/exception
-----------------   -----------------   ------------------
34567               34567               34567
+34567              34567               FormatException
pos 34567           FormatException     34567
34567.              FormatException     FormatException
34,567              FormatException     FormatException
65535               65535               65535
65536               OverflowException   OverflowException
-1                  OverflowException   FormatException
*/

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft