名前付き引数と省略可能な引数 (C# プログラミングガイド)

[アーティクル]
02/21/2013

Visual C# 2010 では名前付き引数と省略可能な引数が導入されています。名前付き引数を使用すると、パラメーターリストのパラメーターの位置ではなく、パラメーター名に引数を関連付けることによって、特定のパラメーターの引数を指定できます。省略可能な引数を使用すると、一部のパラメーターの引数を省略できます。両方の手法をメソッド、インデクサー、コンストラクター、およびデリゲートで使用できます。

名前付き引数および省略可能な引数を使用すると、引数は、パラメーターリストではなく引数リストに記述されている順に評価されます。

名前付きパラメーターと省略可能なパラメーターを併用する場合、省略可能なパラメーターのリストにあるパラメーターのうち、少数のパラメーターに対してのみ引数を指定できます。この機能によって、Microsoft Office オートメーション API などの COM インターフェイスの呼び出しが大幅に簡易化します。

名前付き引数

名前付き引数を使用すると、呼び出されたメソッドのパラメーターリストに記述されているパラメーターの順序を記憶したり、検索したりする必要がありません。各引数のパラメーターはパラメーター名で指定できます。たとえば、肥満度指数 (BMI) を計算する関数は、この関数で定義している順序で体重および身長の引数を位置によって渡す標準的な方法で、呼び出すことができます。

CalculateBMI(123, 64);

しかし、パラメーターの順序を覚えていなくても、パラメーターの名前がわかっていれば、1 番目のパラメーターとして体重または身長のどちらを指定してもよく、任意の順序で引数を渡すことができます。

CalculateBMI(weight: 123, height: 64);

CalculateBMI(height: 64, weight: 123);

また、名前付き引数を使用すると、各引数が何を表すかがわかるのでコードが読みやすくなります。

次に示すように、位置指定引数の後に続けて名前付き引数を指定できます。

CalculateBMI(123, height: 64);

ただし、位置指定引数を名前付き引数の後に続けて指定することはできません。次のステートメントはコンパイラエラーになります。

//CalculateBMI(weight: 123, 64);

例

次のコードには、このセクションの例が実装されています。

class NamedExample
{
    static void Main(string[] args)
    {
        // The method can be called in the normal way, by using positional arguments.
        Console.WriteLine(CalculateBMI(123, 64));

        // Named arguments can be supplied for the parameters in either order.
        Console.WriteLine(CalculateBMI(weight: 123, height: 64));
        Console.WriteLine(CalculateBMI(height: 64, weight: 123));

        // Positional arguments cannot follow named arguments.
        // The following statement causes a compiler error.
        //Console.WriteLine(CalculateBMI(weight: 123, 64));

        // Named arguments can follow positional arguments.
        Console.WriteLine(CalculateBMI(123, height: 64));
    }

    static int CalculateBMI(int weight, int height)
    {
        return (weight * 703) / (height * height);
    }
}

省略可能な引数

メソッド、コンストラクター、インデクサー、またはデリゲートの定義では、そのパラメーターが必須であるか、省略可能であるかを指定できます。どの呼び出しでも、すべての必須パラメーターに対して引数を指定する必要があります。ただし、省略可能なパラメーターの引数は省略できます。

省略可能な各パラメーターの場合、パラメーターの定義に既定値が含まれています。そのパラメーターの引数を渡さない場合は、既定値が使用されます。既定値は式の種類の 1 種類があります :

定数式 ;
ValType は値型である列挙または構造体のような形式の式 new ValType();
ValType は値型であるフォーム既定値 () ValType の表現。

省略可能なパラメーターは、パラメーターリストの末尾で必須パラメーターの後に定義されます。呼び出し元は、連続する省略可能なパラメーターのいずれか 1 つに対して引数を指定する場合、前にあるすべての省略可能なパラメーターに引数を指定する必要があります。引数リストでコンマ区切りのスペースはサポートされていません。たとえば、次のコードでは、1 つの必須パラメーターと 2 つの省略可能なパラメーターでインスタンスメソッド ExampleMethod が定義されます。

public void ExampleMethod(int required, string optionalstr = "default string",
    int optionalint = 10)

次に示す ExampleMethod の呼び出しでは、3 番目のパラメーターに引数が指定されていますが、2 番目のパラメーターには指定されていないため、コンパイルエラーが発生します。

//anExample.ExampleMethod(3, ,4);

ただし、3 番目のパラメーターの名前がわかっている場合は、名前付き引数を使用して処理を実行できます。

anExample.ExampleMethod(3, optionalint: 4);

次の例に示すように、IntelliSense では、省略可能なパラメーターを角かっこで示します。

ExampleMethod の省略可能なパラメーター

ExampleMethod メソッドの IntelliSense によるクイックヒント

[!メモ]

また、.NET OptionalAttribute クラスを使用して省略可能なパラメーターを宣言することもできます。OptionalAttribute パラメーターに既定値は必要ありません。

例

次の例では、ExampleClass のコンストラクターに省略可能なパラメーターが 1 つあります。ExampleMethod インスタンスメソッドには、required という 1 つの必須パラメーターと、optionalstr および optionalint という 2 つの省略可能なパラメーターがあります。Main のコードに示すように、いくつかの異なる方法でコンストラクターとメソッドを呼び出すことができます。

namespace OptionalNamespace
{
    class OptionalExample
    {
        static void Main(string[] args)
        {
            // Instance anExample does not send an argument for the constructor's
            // optional parameter.
            ExampleClass anExample = new ExampleClass();
            anExample.ExampleMethod(1, "One", 1);
            anExample.ExampleMethod(2, "Two");
            anExample.ExampleMethod(3);

            // Instance anotherExample sends an argument for the constructor's
            // optional parameter.
            ExampleClass anotherExample = new ExampleClass("Provided name");
            anotherExample.ExampleMethod(1, "One", 1);
            anotherExample.ExampleMethod(2, "Two");
            anotherExample.ExampleMethod(3);

            // The following statements produce compiler errors.

            // An argument must be supplied for the first parameter, and it
            // must be an integer.
            //anExample.ExampleMethod("One", 1);
            //anExample.ExampleMethod();

            // You cannot leave a gap in the provided arguments. 
            //anExample.ExampleMethod(3, ,4);
            //anExample.ExampleMethod(3, 4);

            // You can use a named parameter to make the previous 
            // statement work.
            anExample.ExampleMethod(3, optionalint: 4);
        }
    }

    class ExampleClass
    {
        private string _name;

        // Because the parameter for the constructor, name, has a default
        // value assigned to it, it is optional.
        public ExampleClass(string name = "Default name")
        {
            _name = name;
        }

        // The first parameter, required, has no default value assigned
        // to it. Therefore, it is not optional. Both optionalstr and 
        // optionalint have default values assigned to them. They are optional.
        public void ExampleMethod(int required, string optionalstr = "default string",
            int optionalint = 10)
        {
            Console.WriteLine("{0}: {1}, {2}, and {3}.", _name, required, optionalstr,
                optionalint);
        }
    }

    // The output from this example is the following:
    // Default name: 1, One, and 1.
    // Default name: 2, Two, and 10.
    // Default name: 3, default string, and 10.
    // Provided name: 1, One, and 1.
    // Provided name: 2, Two, and 10.
    // Provided name: 3, default string, and 10.
    // Default name: 3, default string, and 4.

}

COM インターフェイス

名前付き引数と省略可能な引数を動的オブジェクトやその他の拡張機能のサポートと併用すると、Office オートメーション API などの COM API との相互運用性が向上します。

たとえば、Microsoft Office Excel Range インターフェイスの AutoFormat メソッドには 7 つのパラメーターがあります。それらはすべて省略可能です。これらのパラメーターを次の例に示します。

AutoFormat のパラメーター

AutoFormat メソッドについての IntelliSense によるクイックヒント

C# 3.0 および旧バージョンの C# では、次の例に示すように、各パラメーターの引数が必要です。

// In C# 3.0 and earlier versions, you need to supply an argument for
// every parameter. The following call specifies a value for the first
// parameter, and sends a placeholder value for the other six. The
// default values are used for those parameters.
var excelApp = new Microsoft.Office.Interop.Excel.Application();
excelApp.Workbooks.Add();
excelApp.Visible = true;

var myFormat = 
    Microsoft.Office.Interop.Excel.XlRangeAutoFormat.xlRangeAutoFormatAccounting1;

excelApp.get_Range("A1", "B4").AutoFormat(myFormat, Type.Missing, 
    Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing);

しかし、C# 4.0 の導入により、名前付き引数と省略可能な引数を使用すると、AutoFormat の呼び出しを大幅に簡略化できます。名前付き引数と省略可能な引数を使用すると、パラメーターの既定値の変更を望まない場合に、省略可能なパラメーターの引数を省略できます。次の呼び出しでは、7 つのパラメーターのうち 1 つのパラメーターのみに値を指定しています。

// The following code shows the same call to AutoFormat in C# 4.0. Only
// the argument for which you want to provide a specific value is listed.
excelApp.Range["A1", "B4"].AutoFormat( Format: myFormat );

使用例を含む詳細については、「方法: Office プログラミングで名前付き引数と省略可能な引数を使用する (C# プログラミングガイド)」および「方法: Visual C# 2010 の機能を使用して Office 相互運用オブジェクトにアクセスする (C# プログラミングガイド)」を参照してください。

オーバーロードの解決法

名前付き引数と省略可能な引数を使用すると、オーバーロードの解決に次のように影響します。

メソッド、インデクサー、またはコンストラクターの各パラメーターが省略可能である場合、または呼び出し側ステートメントの 1 つの引数に名前または位置によって対応し、その引数をパラメーターの型に変換できる場合、そのメソッド、インデクサー、またはコンストラクターは実行の候補となります。
複数の候補が見つかった場合は、明示的に指定されている引数に対して、優先される変換のオーバーロードの解決規則が適用されます。省略可能なパラメーターの省略された引数は無視されます。
2 つの候補が同等である場合は、呼び出しで引数が省略された省略可能なパラメーターを持たない候補が優先されます。これは、比較的少ないパラメーターを持つ候補のオーバーロードの解決での一般的な優先順に従った結果です。

C# 言語仕様

詳細については、「C# 言語仕様」を参照してください。言語仕様は、C# の構文と使用法に関する信頼性のある情報源です。

参照

処理手順

方法: Office プログラミングで名前付き引数と省略可能な引数を使用する (C# プログラミングガイド)

その他の技術情報

dynamic 型の使用 (C# プログラミングガイド)

名前付き引数と省略可能な引数 (C# プログラミングガイド)

名前付き引数

例

省略可能な引数

例

COM インターフェイス

オーバーロードの解決法

C# 言語仕様

参照

処理手順

関連項目

その他の技術情報

その他のリソース

名前付き引数と省略可能な引数 (C# プログラミング ガイド)

名前付き引数

例

省略可能な引数

例

COM インターフェイス

オーバーロードの解決法

C# 言語仕様

参照

処理手順

関連項目

その他の技術情報

その他のリソース

名前付き引数と省略可能な引数 (C# プログラミングガイド)