关于System.FormatException异常

什么是FormatException

参数格式无效或复合格式字符串不正确时引发的异常。

继承: Object

Exception

SystemException
FormatException

详细说明

由于以下原因之一, 可能会引发异常:FormatException

在对将字符串转换为其他数据类型的方法的调用中, 该字符串不符合所需模式。这通常发生在调用Convert类的某些方法和某些类型的ParseExact Parse和方法时。

在大多数情况下, 特别是当要转换的字符串是用户输入或从文件中读取时, 应使用try/catch块并FormatException处理异常 (如果转换不成功)。你还可以将对转换方法的调用替换为对TryParse或TryParseExact方法的调用 (如果存在)。但是, FormatException当你尝试分析预定义或硬编码字符串时引发的异常指示程序错误。在这种情况下, 应更正此错误, 而不是处理异常。

将字符串转换为System命名空间中的以下类型可能会FormatException引发异常:
- - Boolean。 Boolean.Parse(String) 和Convert.ToBoolean(String)方法要求将字符串转换为 "true"、"true"、"false" 或 "false"。任何其他值都将FormatException引发异常。
  - DateTime 和 DateTimeOffset。所有日期和时间数据都基于特定区域性的格式设置约定: 当前线程区域性 (或在某些情况下为当前应用程序域区域性)、固定区域性或指定的区域性。在调用DateTime.ParseExact(String, String, IFormatProvider, DateTimeStyles) DateTimeOffset.ParseExact(String, String[], IFormatProvider, DateTimeStyles)和方法时, 日期和时间数据还必须完全符合由一个或多个标准格式字符串或自定义格式字符串(作为中的参数提供) 指定的模式方法调用。如果它不符合预期的区域性特定模式, FormatException则会引发异常。这意味着, 在一个系统上保存为特定于区域性的格式的日期和时间数据可能无法在其他系统上成功分析。
    
    有关分析日期和时间的详细信息, 请参阅分析日期和时间字符串和引发异常的方法的文档。
  - Guid. GUID 的字符串表示形式必须包含32个十六进制数字 (0-F), 并且必须是由Guid.ToString方法输出的五种格式中的一种。有关更多信息，请参见 Guid.Parse 方法。
  - 数值类型, 包括所有有符号整数、无符号整数和浮点类型。 要分析的字符串必须包含拉丁语位数0-9。还可以允许使用正号或负号、小数点分隔符、组分隔符和货币符号。尝试分析包含任何其他字符的字符串始终会引发FormatException异常。
    
    所有数字字符串都基于特定区域性的格式设置约定: 当前线程区域性 (或在某些情况下为当前应用程序域区域性)、固定区域性或指定的区域性。因此, 使用另一种区域性的约定分析的数值字符串可能会失败。
    
    有关分析数值字符串的详细信息, 请参阅分析数值字符串和引发异常的特定方法的文档。
  - 时间间隔。 要分析的字符串必须是采用不区分区域性的格式或由当前线程区域性定义的区分区域性的格式 (在某些情况下为当前应用程序域区域性)、固定区域性或指定的区域性。如果字符串的格式不正确, 或者如果时间间隔的最小值、天数、小时数和分钟数部分不存在, 分析方法将引发FormatException异常。有关详细信息, 请参阅引发异常的TimeSpan分析方法的文档。

类型实现IFormattable接口, 该接口支持定义如何将对象转换为其字符串表示形式, 并使用无效格式字符串的格式字符串。这在格式设置操作中最常见。在下面的示例中, 在复合格式字符串中使用 "Q" 标准格式字符串来设置数值的格式。但是, "Q" 不是有效的标准格式字符串。

using System;

public class Example
{
   public static void Main()
   {
      decimal price = 169.32m;
      Console.WriteLine("The cost is {0:Q2}.", price);
   }
}
// The example displays the following output:
//    Unhandled Exception: System.FormatException: Format specifier was invalid.
//       at System.Number.FormatDecimal(Decimal value, String format, NumberFormatInfo info)
//       at System.Decimal.ToString(String format, IFormatProvider provider)
//       at System.Text.StringBuilder.AppendFormat(IFormatProvider provider, String format, Object[] args)
//       at System.IO.TextWriter.WriteLine(String format, Object arg0)
//       at System.IO.TextWriter.SyncTextWriter.WriteLine(String format, Object arg0)
//       at Example.Main()

此异常是由编码错误引起的。若要更正此错误, 请删除格式字符串或替换有效的字符串。下面的示例通过使用 "C" (货币) 格式字符串替换无效的格式字符串来纠正错误。

using System;

public class Example
{
   public static void Main()
   {
      decimal price = 169.32m;
      Console.WriteLine("The cost is {0:C2}.", price);
   }
}
// The example displays the following output:
//    The cost is $169.32.

还可以通过分析方法 ( DateTime.ParseExact如和Guid.ParseExact) 引发异常,这需要对字符串进行分析,使其符合格式字符串指定的模式。FormatException 在下面的示例中, GUID 的字符串表示形式应符合 "G" 标准格式字符串指定的模式。但是, Guid结构的IFormattable实现不支持 "G" 格式字符串。

using System;

public class Example
{
   public static void Main()
   {
      string guidString = "ba748d5c-ae5f-4cca-84e5-1ac5291c38cb";
      Console.WriteLine(Guid.ParseExact(guidString, "G"));
   }
}
// The example displays the following output:
//    Unhandled Exception: System.FormatException: 
//       Format String can be only "D", "d", "N", "n", "P", "p", "B", "b", "X" or "x".
//       at System.Guid.ParseExact(String input, String format)
//       at Example.Main()

此异常也是由于编码错误引起的。若要更正此错误, 请调用不需要精确格式的分析方法 (如DateTime.Parse或Guid.Parse) 或替换有效的格式字符串。下面的示例通过调用Guid.Parse方法来更正错误。

using System;

public class Example
{
   public static void Main()
   {
      string guidString = "ba748d5c-ae5f-4cca-84e5-1ac5291c38cb";
      Console.WriteLine(Guid.Parse(guidString));
   }
}
// The example displays the following output:
//    ba748d5c-ae5f-4cca-84e5-1ac5291c38cb

复合格式字符串中的格式项的一个或多个索引大于对象列表或参数数组中项的索引。在下面的示例中, 格式字符串中的格式项的最大索引为3。由于对象列表中项的索引是从零开始的, 因此此格式字符串要求对象列表具有四项。相反, 它只有三个、 dat temp、和scale, 因此, 代码会在运行时FormatException导致异常:。

using System;

public class Example
{
   public enum TemperatureScale 
   { Celsius, Fahrenheit, Kelvin }

   public static void Main()
   {
      String info = GetCurrentTemperature();
      Console.WriteLine(info);
   }

   private static String GetCurrentTemperature()
   {
      DateTime dat = DateTime.Now;
      Decimal temp = 20.6m;
      TemperatureScale scale = TemperatureScale.Celsius;
      String result;
      
      result = String.Format("At {0:t} on {1:D}, the temperature is {2:F1} {3:G}",
                             dat, temp, scale);    
      return result;
   }
}
// The example displays output like the following:
//    Unhandled Exception: System.FormatException: Format specifier was invalid.
//       at System.Number.FormatDecimal(Decimal value, String format, NumberFormatInfo info)
//       at System.Decimal.ToString(String format, IFormatProvider provider)
//       at System.Text.StringBuilder.AppendFormat(IFormatProvider provider, String format, Object[] args)
//       at System.String.Format(IFormatProvider provider, String format, Object[] args)
//       at Example.Main()

在这种情况下FormatException , 异常是由开发人员错误引起的。应更正此情况, 而不是通过try/catch确保对象列表中的每个项对应于格式项的索引, 而不是在块中进行处理。若要更正此示例, 请将第二个格式项的索引改为dat引用变量, 并将每个后续格式项的索引减一。

using System;

public class Example
{
   public enum TemperatureScale 
   { Celsius, Fahrenheit, Kelvin }

   public static void Main()
   {
      String info = GetCurrentTemperature();
      Console.WriteLine(info);
   }

   private static String GetCurrentTemperature()
   {
      DateTime dat = DateTime.Now;
      Decimal temp = 20.6m;
      TemperatureScale scale = TemperatureScale.Celsius;
      String result;
      
      result = String.Format("At {0:t} on {0:D}, the temperature is {1:F1} {2:G}",
                             dat, temp, scale);    
      return result;
   }
}
// The example displays output like the following:
//    At 10:40 AM on Wednesday, June 04, 2014, the temperature is 20.6 Celsius

复合格式字符串的格式不正确。发生这种情况时FormatException , 异常始终是由开发人员错误引起的。应更正此情况, 而不是在try/catch块中进行处理。

如以下示例中所示, 尝试在字符串中包含文本大括号会引发异常。
```
result = String.Format("The text has {0} '{' characters and {1} '}' characters.",
                       nOpen, nClose);
```
在复合格式字符串中包含大括号的建议方法是将它们包含在对象列表中, 并使用格式项将它们插入到结果字符串中。例如, 您可以修改上一复合格式字符串, 如下所示。
```
string result;
int nOpen = 1;
int nClose = 2;
result = String.Format("The text has {0} '{{' characters and {1} '}}' characters.",
                       nOpen, nClose);
Console.WriteLine(result);
```
如果格式字符串包含打字错误, 也会引发异常。以下对String.Format方法的调用省略了右大括号, 并对左大括号和右括号配对。
```
int n1 = 10;
int n2 = 20;
String result = String.Format("{0 + {1] = {2}", 
                              n1, n2, n1 + n2);
```
若要更正此错误, 请确保所有左大括号和右大括号对应。
```
String result = String.Format("{0} + {1} = {2}", 
                              n1, n2, n1 + n2);
```

已提供复合格式设置方法中的对象列表作为强类型参数数组, 但该FormatException异常表示一个或多个格式项的索引超过对象列表中的参数数量。出现这种情况的原因是, 数组类型之间没有显式转换, 因此编译器会将该数组视为单个参数, 而不是作为参数数组。例如, 以下对Console.WriteLine(String, Object[])方法的调用将FormatException引发异常, 尽管格式项的最高索引为 3, 而类型Int32的参数数组具有四个元素。

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      Random rnd = new Random();
      int[]  numbers = new int[4];
      int total = 0;
      for (int ctr = 0; ctr <= 2; ctr++) {
         int number = rnd.Next(1001);
         numbers[ctr] = number;
         total += number;
      }   
      numbers[3] = total;
      Console.WriteLine("{0} + {1} + {2} = {3}", numbers);   
   }
}
// The example displays the following output:
//    Unhandled Exception: 
//    System.FormatException: 
//       Index (zero based) must be greater than or equal to zero and less than the size of the argument list.
//       at System.Text.StringBuilder.AppendFormat(IFormatProvider provider, String format, Object[] args)
//       at System.IO.TextWriter.WriteLine(String format, Object arg0)
//       at System.IO.TextWriter.SyncTextWriter.WriteLine(String format, Object arg0)
//       at Example.Main()

应该消除其原因, 而不是处理此异常。因为既不 Visual Basic C#也不能将整数数组转换为对象数组, 所以必须在调用复合格式设置方法之前自行执行转换。下面的示例提供了一个实现。

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      Random rnd = new Random();
      int[]  numbers = new int[4];
      int total = 0;
      for (int ctr = 0; ctr <= 2; ctr++) {
         int number = rnd.Next(1001);
         numbers[ctr] = number;
         total += number;
      }   
      numbers[3] = total;
      object[] values = new object[numbers.Length];
      numbers.CopyTo(values, 0);
      Console.WriteLine("{0} + {1} + {2} = {3}", values);   
   }
}
// The example displays output like the following:
//        477 + 956 + 901 = 2334

HRESULT

FormatException使用 COR_E_FORMAT 值为0x80131537 的 HRESULT。