C# out 参数修饰符

前言

今天接触到了C# 的out修饰符，网上查找资料了解了一下，怕自己忘记写在博客加深一下印象

out 参数修饰符（C# 参考）

功能

out关键字通过引用传递参数。 它与 ref 关键字相似，只不过 ref 要求在传递之前初始化变量。 若要使用 out 参数，方法定义和调用方法均必须显式使用 out 关键字。 例如:

using System;

class OutExample
{
   static void Method(out int i)
   {
      i = 44;
   }

   static void Main()
   {
      int value;
      Method(out value);
      Console.WriteLine(value);     // 控制台输出的是44，value值被改变
   }
}

注意：作为 out 参数传递的变量在方法调用中传递之前不必进行初始化。 但是，被调用的方法需要在返回之前赋一个值。

重载问题

尽管 ref 和 out 关键字会导致不同的运行时行为，它们并不被视为编译时方法签名的一部分。 因此，如果唯一的不同是一个方法采用 ref 参数，而另一个方法采用 out 参数，则无法重载这两个方法。 例如，以下代码将不会编译：

class CS0663_Example
{
    // Compiler error CS0663: "Cannot define overloaded 
    // methods that differ only on ref and out".
    public void SampleMethod(out int i) { }
    public void SampleMethod(ref int i) { }
}

但是，如果一个方法采用 ref 或 out 参数，而另一个方法采用其他参数，则可以完成重载，如：

class OutOverloadExample
{
    public void SampleMethod(int i) { }
    public void SampleMethod(out int i) { i = 5; }
}

声明 out 参数

如果希望方法返回多个值，可以声明具有多个 out 参数的方法。 下面的示例使用 out 返回具有单个方法调用的三个变量。 注意，第三个参数赋 null 值。 这使得方法可以有选择地返回值。

class OutReturnExample
{
    static void Method(out int i, out string s1, out string s2)
    {
        i = 44;
        s1 = "I've been returned";
        s2 = null;
    }

    static void Main()
    {
        int value;
        string str1, str2;
        Method(out value, out str1, out str2);
        // value is now 44
        // str1 is now "I've been returned"
        // str2 is (still) null;
    }
}

重试模式

重试模式会返回一个 bool，指示某个操作是成功还是失败，并在 out 参数中返回该操作生成的值。 许多分析方法（例如 @System.DateTime.TryParse(System.String,@System.DateTime) 方法）采用此模式。
调用具有 out 参数的方法

在 C# 6 及更早版本中，必须先在单独的语句中声明变量，然后才能将其作为 out 参数传递。 下面的示例声明一个名为 number 的变量，然后将其传递给 [Int32.TryParse](xref:System.Int32.TryParse(System.String,@System.Int32) 方法，该方法会尝试将字符串转换为数字。

using System;

public class Example
{
   public static void Main()
   {
      string value = "1640";

      int number;
      if (Int32.TryParse(value, out number))
         Console.WriteLine($"Converted '{value}' to {number}");
      else
         Console.WriteLine($"Unable to convert '{value}'");   
   }
}
// The example displays the following output:
//       Converted '1640' to 1640

在参数列表中申明out变量

从 C# 7 开始，可以在方法调用的参数列表而不是单独的变量声明中声明 out 变量。 这使得代码更简洁可读，还能防止在方法调用之前无意中向该变量赋值。 下面的示例与上一个示例基本相同，只不过它在对 [Int32.TryParse](xref:System.Int32.TryParse(System.String,@System.Int32) 方法的调用中定义了 number 变量。
C#

using System;

public class Example
{
   public static void Main()
   {
      string value = "1640";

      if (Int32.TryParse(value, out int number))
         Console.WriteLine($"Converted '{value}' to {number}");
      else
         Console.WriteLine($"Unable to convert '{value}'");   
   }
}
// The example displays the following output:
//       Converted '1640' to 1640

在上一个示例中，number 变量被强类型化为 int。 你也可以声明一个隐式类型本地变量，如以下示例所示。

using System;

public class Example
{
   public static void Main()
   {
      string value = "1640";

      if (Int32.TryParse(value, out var number))
         Console.WriteLine($"Converted '{value}' to {number}");
      else
         Console.WriteLine($"Unable to convert '{value}'");   
   }
}
// The example displays the following output:
//       Converted '1640' to 1640

参考链接