ReturnValueNameAttribute Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Spécifie le nom de la valeur de retour d’une méthode dans un composant 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 AttributePublic NotInheritable Class ReturnValueNameAttribute
Inherits Attribute- Héritage
- Attributs
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 (Windows Runtime Outil d’exportation de métadonnées) donne à la valeur de retour le nom « value ». Lorsque vous utilisez un composant dans une application store Windows 8.x é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 out paramètres (ByRef paramètres avec l’attribut OutAttribute en 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 attribuer un nom différent à la valeur de retour si vous avez déjà un paramètre nommé « value ». Ou vous pouvez 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
Constructeurs
| ReturnValueNameAttribute(String) |
Initialise une nouvelle instance de la classe ReturnValueNameAttribute et spécifie le nom de la valeur de retour. |
Propriétés
| Name |
Obtient le nom qui a été spécifié pour la valeur de retour d’une méthode dans un composant Windows Runtime. |
| TypeId |
Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute) |
Méthodes
| Equals(Object) |
Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute) |
| GetHashCode() |
Retourne le code de hachage de cette instance. (Hérité de Attribute) |
| GetType() |
Obtient le Type de l'instance actuelle. (Hérité de Object) |
| IsDefaultAttribute() |
En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute) |
| Match(Object) |
En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute) |
| MemberwiseClone() |
Crée une copie superficielle du Object actuel. (Hérité de Object) |
| ToString() |
Retourne une chaîne qui représente l'objet actuel. (Hérité de Object) |
Implémentations d’interfaces explicites
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface. (Hérité de Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Fournit l'accès aux propriétés et aux méthodes exposées par un objet. (Hérité de Attribute) |
