DefaultParameterValueAttribute クラス

定義

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 相互運用機能インターフェイスのメソッドの既定のパラメーターを指定する場合に特に便利です。

コンストラクター

プロパティ

メソッド

明示的なインターフェイスの実装

適用対象