ParamArrayAttribute Klasse

Definition

Namespace:

System

Assembly:

mscorlib.dll

Gibt an, dass eine Methode eine variable Anzahl von Argumenten in ihrem Aufruf zulässt. Diese Klasse kann nicht vererbt werden.

public ref class ParamArrayAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=true)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ParamArrayAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=true)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ParamArrayAttribute = class
    inherit Attribute

Public NotInheritable Class ParamArrayAttribute
Inherits Attribute

Vererbung

Object

Attribute

ParamArrayAttribute

Attribute

AttributeUsageAttribute ComVisibleAttribute

Beispiele

Im folgenden Beispiel wird eine Temperature Klasse definiert, die eine Display Methode enthält, die für die Anzeige eines oder mehrerer formatierter Temperaturwerte vorgesehen ist. Die Methode verfügt über einen einzelnen Parameter, formatsder als Parameterarray definiert ist.

using System;

public class Temperature
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      this.temp = temperature;
   }

   public override string ToString()
   {
      return ToString("C");
   }

   public string ToString(string format)
   {
      if (String.IsNullOrEmpty(format))
         format = "G";

      switch (format.ToUpper())
      {
         case "G":
         case "C":
            return temp.ToString("N") + "  °C";
         case "F":
            return (9 * temp / 5 + 32).ToString("N") + "  °F";
         case "K":
            return (temp + 273.15m).ToString("N") + "  °K";
         default:
            throw new FormatException(String.Format("The '{0}' format specifier is not supported",
                                                    format));
      }
   }

   public void Display(params string []formats)
   {
      if (formats.Length == 0)
      {
         Console.WriteLine(this.ToString("G"));
      }
      else
      {
         foreach (string format in formats)
         {
            try {
               Console.WriteLine(this.ToString(format));
            }
            // If there is an exception, do nothing.
            catch { }
         }
      }
   }
}

open System

type Temperature(temperature) =
    override this.ToString() =
        this.ToString "C"

    member _.ToString(format) =
        let format = 
            if String.IsNullOrEmpty format then "G"
            else format

        match format.ToUpper() with
        | "G" | "C" ->
            $"{temperature:N}  °C"
        | "F" ->
            $"{9. * temperature / 5. + 32.:N}  °F"
        | "K" ->
            $"{temperature + 273.15:N}  °K"
        | _ ->
            raise (FormatException $"The '{format}' format specifier is not supported")

    member this.Display([<ParamArray>]formats: string[]) =
        if formats.Length = 0 then
            printfn $"""{this.ToString "G"}"""
        else
            for format in formats do
                try
                    printfn $"{this.ToString format}"
                // If there is an exception, do nothing.
                with _ -> ()

Public Class Temperature 
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      Me.temp = temperature
   End Sub
   
   Public Overrides Function ToString() As String
      Return ToString("C")
   End Function
   
   Public Overloads Function ToString(format As String) As String
      If String.IsNullOrEmpty(format) Then format = "G"
      
      Select Case format
         Case "G", "C"
            Return temp.ToString("N") + "  °C"
         Case "F"
            Return (9 * temp / 5 + 32).ToString("N") + "  °F"
         Case "K" 
            Return (temp + 273.15d).ToString("N") + "  °K" 
         Case Else
            Throw New FormatException(String.Format("The '{0}' format specifier is not supported", _
                                                    format))
      End Select                                                         
   End Function         
   
   Public Sub Display(<[ParamArray]()> formats() As String)
      If formats.Length = 0 Then
         Console.WriteLine(Me.ToString("G"))
      Else   
         For Each format As String In formats
            Try
               Console.WriteLine(Me.ToString(format))
            ' If there is an exception, do nothing.
            Catch
            End Try   
         Next
      End If
   End Sub
End Class

Im folgenden Beispiel werden drei verschiedene Aufrufe der Temperature.Display Methode veranschaulicht. In der ersten Wird die Methode ein Array von Formatzeichenfolgen übergeben. Im zweiten Wird die Methode vier einzelne Formatzeichenfolgen als Argumente übergeben. Im dritten wird die Methode ohne Argumente aufgerufen. Wie die Ausgabe aus dem Beispiel veranschaulicht wird, übersetzen die Visual Basic- und C#-Compiler dies in einen Aufruf der Display-Methode mit einem leeren Zeichenfolgenarray.

public class Class1
{
   public static void Main()
   {
      Temperature temp1 = new Temperature(100);
      string[] formats = { "C", "G", "F", "K" };

      // Call Display method with a string array.
      Console.WriteLine("Calling Display with a string array:");
      temp1.Display(formats);
      Console.WriteLine();

      // Call Display method with individual string arguments.
      Console.WriteLine("Calling Display with individual arguments:");
      temp1.Display("C", "F", "K", "G");
      Console.WriteLine();

      // Call parameterless Display method.
      Console.WriteLine("Calling Display with an implicit parameter array:");
      temp1.Display();
   }
}
// The example displays the following output:
//       Calling Display with a string array:
//       100.00  °C
//       100.00  °C
//       212.00  °F
//       373.15  °K
//
//       Calling Display with individual arguments:
//       100.00  °C
//       212.00  °F
//       373.15  °K
//       100.00  °C
//
//       Calling Display with an implicit parameter array:
//       100.00  °C

let temp1 = Temperature 100.
let formats = [| "C"; "G"; "F"; "K" |]

// Call Display method with a string array.
printfn "Calling Display with a string array:"
temp1.Display formats

// Call Display method with individual string arguments.
printfn "\nCalling Display with individual arguments:"
temp1.Display("C", "F", "K", "G")

// Call parameterless Display method.
printfn "\nCalling Display with an implicit parameter array:"
temp1.Display()
// The example displays the following output:
//       Calling Display with a string array:
//       100.00  °C
//       100.00  °C
//       212.00  °F
//       373.15  °K
//
//       Calling Display with individual arguments:
//       100.00  °C
//       212.00  °F
//       373.15  °K
//       100.00  °C
//
//       Calling Display with an implicit parameter array:
//       100.00  °C

Public Module Example
   Public Sub Main()
      Dim temp1 As New Temperature(100)
      Dim formats() As String = { "C", "G", "F", "K" } 

      ' Call Display method with a string array.
      Console.WriteLine("Calling Display with a string array:")
      temp1.Display(formats)
      Console.WriteLine()
      
      ' Call Display method with individual string arguments.
      Console.WriteLine("Calling Display with individual arguments:")
      temp1.Display("C", "F", "K", "G")
      Console.WriteLine()
      
      ' Call parameterless Display method.
      Console.WriteLine("Calling Display with an implicit parameter array:")
      temp1.Display()
   End Sub
End Module
' The example displays the following output:
'       Calling Display with a string array:
'       100.00  °C
'       100.00  °C
'       212.00  °F
'       373.15  °K
'       
'       Calling Display with individual arguments:
'       100.00  °C
'       212.00  °F
'       373.15  °K
'       100.00  °C
'       
'       Calling Display with an implicit parameter array:
'       100.00  °C

Hinweise

Der ParamArrayAttribute Wert gibt an, dass ein Methodenparameter ein Parameterarray ist. Ein Parameterarray ermöglicht die Angabe einer unbekannten Anzahl von Argumenten. Ein Parameterarray muss der letzte Parameter in einer formalen Parameterliste sein, und es muss sich um ein Array mit einer Dimension sein. Wenn die Methode aufgerufen wird, lässt ein Parameterarray argumentieren, dass eine Methode auf zwei Arten angegeben werden kann:

• Als einzelner Ausdruck eines Typs, der implizit in den Parameterarraytyp konvertierbar ist. Das Parameterarray fungiert als Wertparameter.

• Als Null oder mehr Argumente, wobei jedes Argument ein Ausdruck eines Typs ist, der implizit in den Typ des Parameterarrayelements umgewandelt wird.

Das Beispiel im nächsten Abschnitt veranschaulicht beide Aufrufkonventionen.

Note

In der Regel wird die ParamArrayAttribute Datei nicht direkt im Code verwendet. Stattdessen werden einzelne Sprachstichwörter wie ParamArray in Visual Basic und params in C# als Wrapper für die klasse ParamArrayAttribute verwendet. Einige Sprachen, z. B. C#, erfordern möglicherweise sogar die Verwendung des Schlüsselworts und verbieten die Verwendung von ParamArrayAttribute.

Wenn Compiler, die Parameterarrays unterstützen, während der Überladung während der Überladung auf eine nicht vorhandene Methodenüberladung stößt, die jedoch einen Parameter hat als eine Überladung, die ein Parameterarray enthält, ersetzen sie die Methode durch die Überladung, die das Parameterarray enthält. Beispielsweise wird ein Aufruf der String.Split() Instanzmethode (die in der String Klasse nicht vorhanden ist) als Aufruf der String.Split(Char[]) Methode aufgelöst. Der Compiler übergibt auch ein leeres Array des erforderlichen Typs an die Methode. Dies bedeutet, dass die Methode immer bereit sein muss, ein Array zu verarbeiten, dessen Länge null ist, wenn die Elemente im Parameterarray verarbeitet werden. Das Beispiel stellt eine Abbildung bereit.

Weitere Informationen zur Verwendung von Attributen finden Sie unter "Attribute".

Konstruktoren

Name	Beschreibung
ParamArrayAttribute()	Initialisiert eine neue Instanz der ParamArrayAttribute Klasse mit Standardeigenschaften.

Eigenschaften

Name	Beschreibung
TypeId	Wenn sie in einer abgeleiteten Klasse implementiert wird, wird ein eindeutiger Bezeichner für diese Attribute. (Geerbt von Attribute)

Methoden

Name	Beschreibung
Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz einem angegebenen Objekt entspricht. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diesen instance zurück. (Geerbt von Attribute)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Wenn sie in einer abgeleiteten Klasse überschrieben wird, gibt an, ob der Wert dieser Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem angegebenen Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Explizite Schnittstellenimplementierungen

Name	Beschreibung
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu. (Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit denen die Typinformationen für eine Schnittstelle abgerufen werden können. (Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1). (Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Bietet Zugriff auf Eigenschaften und Methoden, die von einem Objekt verfügbar gemacht werden. (Geerbt von Attribute)

Weitere Informationen

• Attribute
• Erweitern von Metadaten mithilfe von Attributen