DefaultParameterValueAttribute Klas

Definitie

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

Overname

Object

Attribute

DefaultParameterValueAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u het DefaultParameterValueAttribute kenmerk toepast op een parameter van een methode die is geschreven in C#. Het codefragment maakt ook gebruik van het OptionalAttribute kenmerk om de methode zonder argumenten aan te roepen.

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

Er zijn enkele gedragsverschillen tussen optionele C#-argumenten en het gebruik DefaultParameterValueAttribute met OptionalAttribute. In het volgende codefragment ziet u deze verschillen.

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
}

Opmerkingen

Met DefaultParameterValueAttribute het kenmerk kunt u een standaardparameterwaarde opgeven in een taal die anders geen ondersteuning biedt voor standaardparameters. Nadat u dit kenmerk op uw code hebt toegepast, kunnen talen die ondersteuning bieden voor standaardparameters de opgegeven waarde gebruiken als een standaardparameter.

Het DefaultParameterValueAttribute is met name handig om standaardparameters op te geven voor methoden van een COM-interoperabiliteitsinterface.