ReturnValueNameAttribute Classe

Définition

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

Héritage

Object

Attribute

ReturnValueNameAttribute

Attributs

AttributeUsageAttribute

Remarques

Dans un composant Windows Runtime, tous les paramètres d’une méthode et la valeur de retour doivent avoir des noms. Par défaut, Winmdexp.exe (outil d’exportation de métadonnées Windows Runtime) donne la valeur de retour « value ». Lorsque vous utilisez un composant dans une application Windows 8.x Store écrite en JavaScript, vous pouvez utiliser ce nom pour récupérer la valeur de retour. Par exemple, supposons qu’un composant définit une méthode qui a une valeur de retour et deux paramètres out (paramètres ByRef avec l’attribut OutAttribute dans 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

Lorsque vous appelez la fonction à partir de JavaScript, vous pouvez accéder à la valeur de retour par son nom par défaut (value) :

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

Vous devez donner à la valeur de retour un nom différent si vous avez déjà un paramètre nommé « value ». Vous pouvez également simplement utiliser un nom plus explicite (par exemple, « moyenne » dans cet exemple). Appliquez l’attribut ReturnValueNameAttribute à votre méthode et spécifiez un nouveau nom.

[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