Convert.ToInt64 Method (String, IFormatProvider)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

Syntax

Public Shared Function ToInt64 ( _
    value As String, _
    provider As IFormatProvider _
) As Long
public static long ToInt64(
    string value,
    IFormatProvider provider
)

Parameters

Return Value

Type: System..::.Int64
A 64-bit signed integer equivalent to the value of value.
-or-
Zero if value is nullNothingnullptra null reference (Nothing in Visual Basic).

Exceptions

Exception Condition
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.

Remarks

The return value is the result of invoking the Int64..::.Parse method 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 nullNothingnullptra null reference (Nothing in Visual Basic), the NumberFormatInfo for the current culture is used.

If you prefer not to handle an exception if the conversion fails, you can call the Int64..::.TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

Examples

The following code example converts String representations of 64-bit integers with the ToInt64 method, using an IFormatProvider object.

' Example of the Convert.ToInt64( String ) and 
' Convert.ToInt64( String, IFormatProvider ) methods.
Imports System.Globalization

Module Example

   Dim format As String = "{0,-22}{1,-20}{2}"

   ' Get the exception type name; remove the namespace prefix.
   Function GetExceptionType(ByVal ex As Exception) As String

      Dim exceptionType As String = ex.GetType().ToString()
      Return exceptionType.Substring( _
          exceptionType.LastIndexOf("."c) + 1)
   End Function

   Sub ConvertToInt64(ByVal outputBlock As System.Windows.Controls.TextBlock, ByVal numericStr As String, _
       ByVal provider As IFormatProvider)

      Dim defaultValue As Object
      Dim providerValue As Object

      ' Convert numericStr to Int64 without a format provider.
      Try
         defaultValue = Convert.ToInt64(numericStr)
      Catch ex As Exception
         defaultValue = GetExceptionType(ex)
      End Try

      ' Convert numericStr to Int64 with a format provider.
      Try
         providerValue = Convert.ToInt64(numericStr, provider)
      Catch ex As Exception
         providerValue = GetExceptionType(ex)
      End Try

      outputBlock.Text &= String.Format(format, numericStr, _
          defaultValue, providerValue) & vbCrLf
   End Sub

   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

      ' Create a NumberFormatInfo object and set several of its
      ' properties that apply to numbers.
      Dim provider As NumberFormatInfo = 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 Integer() {3}
      provider.NumberNegativePattern = 0

      outputBlock.Text &= String.Format("This example of" & vbCrLf & _
          "  Convert.ToInt64( String ) and " & vbCrLf & _
          "  Convert.ToInt64( String, IFormatProvider ) " & _
          vbCrLf & "generates the following output. It " & _
          "converts several strings to " & vbCrLf & "Long " & _
          "values, using default formatting " & _
          "or a NumberFormatInfo object." & vbCrLf) & vbCrLf
      outputBlock.Text &= String.Format(format, "String to convert", _
          "Default/exception", "Provider/exception") & vbCrLf
      outputBlock.Text &= String.Format(format, "-----------------", _
          "-----------------", "------------------") & vbCrLf

      ' Convert strings, with and without an IFormatProvider.
      ConvertToInt64(outputBlock, "123456789", provider)
      ConvertToInt64(outputBlock, "+123456789", provider)
      ConvertToInt64(outputBlock, "pos 123456789", provider)
      ConvertToInt64(outputBlock, "-123456789", provider)
      ConvertToInt64(outputBlock, "neg 123456789", provider)
      ConvertToInt64(outputBlock, "123456789.", provider)
      ConvertToInt64(outputBlock, "123,456,789", provider)
      ConvertToInt64(outputBlock, "(123456789)", provider)
      ConvertToInt64(outputBlock, "9223372036854775808", provider)
      ConvertToInt64(outputBlock, "-9223372036854775809", provider)
   End Sub
End Module

' This example of
'   Convert.ToInt64( String ) and
'   Convert.ToInt64( String, IFormatProvider )
' generates the following output. It converts several strings to
' Long values, using default formatting or a NumberFormatInfo object.
' 
' String to convert     Default/exception   Provider/exception
' -----------------     -----------------   ------------------
' 123456789             123456789           123456789
' +123456789            123456789           FormatException
' pos 123456789         FormatException     123456789
' -123456789            -123456789          FormatException
' neg 123456789         FormatException     -123456789
' 123456789.            FormatException     FormatException
' 123,456,789           FormatException     FormatException
' (123456789)           FormatException     FormatException
' 9223372036854775808   OverflowException   OverflowException
' -9223372036854775809  OverflowException   FormatException
// Example of the Convert.ToInt64( string ) and 
// Convert.ToInt64( string, IFormatProvider ) methods.
using System;
using System.Globalization;

class Example
{
   static string format = "{0,-22}{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 ConvertToInt64(System.Windows.Controls.TextBlock outputBlock, string numericStr,
       IFormatProvider provider)
   {
      object defaultValue;
      object providerValue;

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

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

      outputBlock.Text += String.Format(format, numericStr,
          defaultValue, providerValue) + "\n";
   }

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // 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 };
      provider.NumberNegativePattern = 0;

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

      // Convert strings, with and without an IFormatProvider.
      ConvertToInt64(outputBlock, "123456789", provider);
      ConvertToInt64(outputBlock, "+123456789", provider);
      ConvertToInt64(outputBlock, "pos 123456789", provider);
      ConvertToInt64(outputBlock, "-123456789", provider);
      ConvertToInt64(outputBlock, "neg 123456789", provider);
      ConvertToInt64(outputBlock, "123456789.", provider);
      ConvertToInt64(outputBlock, "123,456,789", provider);
      ConvertToInt64(outputBlock, "(123456789)", provider);
      ConvertToInt64(outputBlock, "9223372036854775808", provider);
      ConvertToInt64(outputBlock, "-9223372036854775809", provider);
   }
}

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

String to convert     Default/exception   Provider/exception
-----------------     -----------------   ------------------
123456789             123456789           123456789
+123456789            123456789           FormatException
pos 123456789         FormatException     123456789
-123456789            -123456789          FormatException
neg 123456789         FormatException     -123456789
123456789.            FormatException     FormatException
123,456,789           FormatException     FormatException
(123456789)           FormatException     FormatException
9223372036854775808   OverflowException   OverflowException
-9223372036854775809  OverflowException   FormatException
*/

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Convert Class

ToInt64 Overload

System Namespace