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 komponentě prostředí Windows Runtime.

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) dává návratové hodnotě název "value". Když použijete komponentu 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 out parametry (ByRef parametry s atributem OutAttribute v jazyce 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ě pomocí jejího 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 už máte parametr s názvem "value", musíte návratovou hodnotu pojmenovat jinak. Nebo můžete jednoduše použít smysluplnější název (v tomto příkladu třeba "průměr"). ReturnValueNameAttribute Použijte atribut na metodu 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

ReturnValueNameAttribute(String)

Inicializuje novou instanci ReturnValueNameAttribute třídy a určuje název návratové hodnoty.

Vlastnosti

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

Metody

Equals(Object)	Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí hodnotu hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance 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á označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• Vytváření prostředí Windows Runtime komponent v jazyce C# a Visual Basic