ReturnValueNameAttribute Klasse

Definition

Namespace:

System.Runtime.InteropServices.WindowsRuntime

Assembly:

System.Runtime.InteropServices.WindowsRuntime.dll

Gibt den Namen des Rückgabewerts einer Methode in einer Komponente für Windows-Runtime an.

public ref class ReturnValueNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)]
public sealed class ReturnValueNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)>]
type ReturnValueNameAttribute = class
    inherit Attribute

Public NotInheritable Class ReturnValueNameAttribute
Inherits Attribute

Vererbung

Object

Attribute

ReturnValueNameAttribute

Attribute

AttributeUsageAttribute

Hinweise

In einer Windows-Runtime Komponente müssen alle Parameter einer Methode und der Rückgabewert Namen aufweisen. Standardmäßig gibt Winmdexp.exe (Windows-Runtime Metadatenexporttool) dem Rückgabewert den Namen "value". Wenn Sie eine Komponente in einer in JavaScript geschriebenen Windows 8.x Store-App verwenden, können Sie diesen Namen verwenden, um den Rückgabewert abzurufen. Angenommen, eine Komponente definiert eine Methode mit einem Rückgabewert und zwei out Parametern (ByRef Parameter mit dem OutAttribute -Attribut in Visual Basic):

public static int ComputeAverage([ReadOnlyArray()] int[] input,  
    out int minValue, out int maxValue)  
{  
    …  
}  

Public Shared Function ComputeAverage( _  
        <ReadOnlyArray()> ByVal input As Integer, _  
        <Out()> ByRef minValue As Integer, _  
        <Out()> ByRef maxValue As Integer) As Integer  
    …  
End Function  

Wenn Sie die Funktion aus JavaScript aufrufen, können Sie auf den Rückgabewert mit seinem Standardnamen (value) zugreifen:

var data = [5, 13, 23, 37];  
var results = SampleComponent.TestStuff.computeAverage(data);  
var formattedResults = "Min=" + results.minValue + ", Avg=" +   
    results.value + ", Max=" + results.maxValue;  

Sie müssen dem Rückgabewert einen anderen Namen geben, wenn Sie bereits über einen Parameter mit dem Namen "value" verfügen. Oder Sie möchten einfach einen aussagekräftigeren Namen verwenden (z. B. "Durchschnitt" in diesem Beispiel). Wenden Sie das ReturnValueNameAttribute Attribut auf Ihre Methode an, und geben Sie einen neuen Namen an.

[return: ReturnValueName("average")]  
public static int ComputeAverage([ReadOnlyArray()] int[] input,  
    out int minValue, out int maxValue)  
{  
    …  
}  

Public Shared Function ComputeAverage( _  
        <ReadOnlyArray()> ByVal input As Integer, _  
        <Out()> ByRef minValue As Integer, _  
        <Out()> ByRef maxValue As Integer) _  
            As <ReturnValueName("average")> Integer  
    …  
End Function  

Konstruktoren

ReturnValueNameAttribute(String)

Initialisiert eine neue Instanz der ReturnValueNameAttribute-Klasse und gibt den Namen des Rückgabewerts an.

Eigenschaften

Name	Ruft den Namen ab, der für den Rückgabewert einer Methode in einer Windows-Runtime-Komponente angegeben wurde.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

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)

Weitere Informationen

• Erstellen von Windows-Runtime-Komponenten in C# und Visual Basic