DefaultParameterValueAttribute クラス

定義

名前空間:

System.Runtime.InteropServices

アセンブリ:

System.Runtime.InteropServices.dll

ソース:

DefaultParameterValueAttribute.cs

既定のパラメーターをサポートする言語から呼び出された場合の、パラメーターの既定値を設定します。 このクラスは継承できません。

public ref class DefaultParameterValueAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter)]
public sealed class DefaultParameterValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter)>]
type DefaultParameterValueAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultParameterValueAttribute
Inherits Attribute

継承

Object

Attribute

DefaultParameterValueAttribute

属性

AttributeUsageAttribute

例

次のコード例では、C# で記述された DefaultParameterValueAttribute メソッドのパラメーターに 属性を適用する方法を示します。 スニペットでは、 属性を OptionalAttribute 使用して、 メソッドを引数なしで呼び出すこともできます。

using System;
using System.Runtime.InteropServices;

public class Program
{
    public static void MethodWithDefaultParam([Optional, DefaultParameterValue("DEFAULT_PARAM_VALUE")] string str)
    {
        Console.WriteLine($"The passed value is: {str}");
    }

    public static void Main()
    {
        MethodWithDefaultParam(); // The passed value is: DEFAULT_PARAM_VALUE
        MethodWithDefaultParam("NEW_VALUE"); // The passed value is: NEW_VALUE
    }    
}

C# の省略可能な引数と で OptionalAttributeを使用DefaultParameterValueAttributeする場合には、いくつかの動作の違いがあります。 次のコード スニペットは、これらの違いを示しています。

using System.Runtime.InteropServices;

public class Program
{
    public static void MethodWithObjectDefaultAttr1([Optional, DefaultParameterValue(123)] object obj) {} // OK
    public static void MethodWithObjectDefaultAttr2([Optional, DefaultParameterValue("abc")] object obj) {} // OK
    public static void MethodWithObjectDefaultAttr3([Optional, DefaultParameterValue(null)] object? obj) {} // OK

    public static void MethodWithObjectDefaultParam1(object obj = 123) {} // CS1763
    public static void MethodWithObjectDefaultParam2(object obj = "abc") {} // CS1763
    public static void MethodWithObjectDefaultParam3(object obj? = null) {} // OK
}

注釈

DefaultParameterValueAttribute属性を使用すると、既定のパラメーターをサポートしない言語で既定のパラメーター値を指定できます。 この属性をコードに適用した後、既定のパラメーターをサポートする言語では、指定した値を既定のパラメーターとして使用できます。

DefaultParameterValueAttributeは、COM 相互運用機能インターフェイスのメソッドの既定のパラメーターを指定する場合に特に便利です。

コンストラクター

DefaultParameterValueAttribute(Object)

パラメーターの既定値を使用して、DefaultParameterValueAttribute クラスの新しいインスタンスを初期化します。

プロパティ

TypeId	派生クラスで実装されると、この Attribute の一意の識別子を取得します。 (継承元 Attribute)
Value	パラメーターの既定値を取得します。

メソッド

Equals(Object)	このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。 (継承元 Attribute)
GetHashCode()	このインスタンスのハッシュ コードを返します。 (継承元 Attribute)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
IsDefaultAttribute()	派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。 (継承元 Attribute)
Match(Object)	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (継承元 Attribute)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)