DefaultParameterValueAttribute Klasse

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Quelle:

DefaultParameterValueAttribute.cs

Legt den Standardwert eines Parameters fest, wenn dieser mit einer Sprache aufgerufen wird, die Standardparameter unterstützt. Diese Klasse kann nicht vererbt werden.

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

Vererbung

Object

Attribute

DefaultParameterValueAttribute

Attribute

AttributeUsageAttribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie das DefaultParameterValueAttribute Attribut auf einen Parameter einer in C# geschriebenen Methode angewendet wird. Der Codeausschnitt verwendet auch das OptionalAttribute -Attribut, um den Aufruf der Methode ohne Argumente zu ermöglichen.

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
    }    
}

Es gibt einige Verhaltensunterschiede zwischen optionalen C#-Argumenten und der Verwendung DefaultParameterValueAttribute mit OptionalAttribute. Der folgende Codeausschnitt veranschaulicht diese Unterschiede.

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
}

Hinweise

Mit DefaultParameterValueAttribute dem Attribut können Sie einen Standardwert in einer Sprache angeben, die sonst keine Standardparameter unterstützt. Nachdem Sie dieses Attribut auf Ihren Code angewendet haben, können Sprachen, die Standardparameter unterstützen, den angegebenen Wert als Standardparameter verwenden.

Die DefaultParameterValueAttribute ist besonders nützlich, um Standardparameter für Methoden einer COM-Interop-Schnittstelle anzugeben.

Konstruktoren

DefaultParameterValueAttribute(Object)

Initialisiert eine neue Instanz der DefaultParameterValueAttribute-Klasse mit dem Standardwert eines Parameters.

Eigenschaften

TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)
Value	Ruft den Standardwert eines Parameters ab.

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)