ReturnValueNameAttribute Klasse

Definition

Namespace:

System.Runtime.InteropServices.WindowsRuntime

Assembly:

System.Runtime.InteropServices.WindowsRuntime.dll

Gibt den Namen des Rückgabewerts einer Methode in einer Windows-Runtime Komponente 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 enthalten. 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 Attribut OutAttribute 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 dem Standardnamen (value):

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 zuweisen, wenn Sie bereits über einen Parameter mit dem Namen "value" verfügen. Oder Sie möchten einfach einen aussagekräftigeren Namen verwenden (z. B. "Mittelwert" 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

Name	Beschreibung
ReturnValueNameAttribute(String)	Initialisiert eine neue Instanz der ReturnValueNameAttribute Klasse und gibt den Namen des Rückgabewerts an.

Eigenschaften

Name	Beschreibung
Name	Ruft den Namen ab, der für den Rückgabewert einer Methode in einer Windows-Runtime Komponente angegeben wurde.
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 diese Instanz 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)