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

範例

下列程式代碼範例示範如何將 屬性套用 DefaultParameterValueAttribute 至以 C# 撰寫之方法的參數。 代碼段也會使用 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 Interop 介面方法的預設參數。

建構函式

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)