ReturnValueNameAttribute Třída

Definice

Obor názvů:

System.Runtime.InteropServices.WindowsRuntime

Sestavení:

System.Runtime.InteropServices.WindowsRuntime.dll

Určuje název návratové hodnoty metody v prostředí Windows Runtime komponentě.

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

Dědičnost

Object

Attribute

ReturnValueNameAttribute

Atributy

AttributeUsageAttribute

Poznámky

V komponentě prostředí Windows Runtime musí mít všechny parametry metody a návratová hodnota názvy. Ve výchozím nastavení Winmdexp.exe (nástroj pro export metadat prostředí Windows Runtime) vrátí vrácenou hodnotu název "value". Při použití komponenty v aplikaci Windows 8.x Store napsané v JavaScriptu můžete tento název použít k načtení návratové hodnoty. Předpokládejme například, že komponenta definuje metodu, která má návratovou hodnotu a dva parametry out (parametry ByRef s atributem OutAttribute v 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

Při volání funkce z JavaScriptu můžete získat přístup k návratové hodnotě podle výchozího názvu (value):

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

Pokud již máte parametr s názvem "value", musíte vrátit návratovou hodnotu jiným názvem. Nebo můžete chtít použít smysluplnější název (například "průměr" v tomto příkladu). Použijte atribut pro vaši metodu ReturnValueNameAttribute a zadejte nový název.

[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

Konstruktory

Name	Description
ReturnValueNameAttribute(String)	Inicializuje novou instanci ReturnValueNameAttribute třídy a určuje název návratové hodnoty.

Vlastnosti

Name	Description
Name	Získá název, který byl zadán pro návratovou hodnotu metody v prostředí Windows Runtime komponentě.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)