ReturnValueNameAttribute Třída

  • Reference

Definice

Obor názvů:
System.Runtime.InteropServices.WindowsRuntime
Sestavení:
System.Runtime.InteropServices.WindowsRuntime.dll
Sestavení:
mscorlib.dll

Určuje název návratové hodnoty metody v komponentě 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 Windows Runtime musí mít všechny parametry metody a návratovou hodnotu názvy. Ve výchozím nastaveníWinmdexp.exe (Windows Runtime Metadata Export Tool) dává návratové hodnotě název "value". Když použijete komponentu v aplikaci Windows 8.x Store napsané v JavaScriptu, můžete pomocí tohoto názvu načíst vrácenou hodnotu. Předpokládejme například, že komponenta definuje metodu, která má návratovou hodnotu a dva parametry ( parametry s out ByRef OutAttribute atributem 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 k návratové hodnotě přistupovat pomocí 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ávratové hodnotě dát jiný název. Nebo můžete jednoduše chtít použít smysluplnější název (například "průměr" v tomto příkladu). Použijte ReturnValueNameAttribute 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 třídy a ReturnValueNameAttribute určuje název návratové hodnoty.

Vlastnosti

Name

Získá název, který byl zadán pro návratovou hodnotu metody v komponentě Windows Runtime.
TypeId

Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute.

(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á aktuální instanci.

(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 odvozené třídy.

(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ří použádnou kopii aktuálního souboru Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Explicitní implementace rozhraní

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání.

(Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Načte informace o typu objektu, který lze použít k získání informací o typu rozhraní.

(Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1).

(Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Poskytuje přístup k vlastnostem a metodám vystaveným objektem.

(Zděděno od Attribute)

Platí pro

Viz také