ReturnValueNameAttribute Clase

Definición

Espacio de nombres:

System.Runtime.InteropServices.WindowsRuntime

Ensamblado:

System.Runtime.InteropServices.WindowsRuntime.dll

Especifica el nombre del valor devuelto de un método en un componente de 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

Herencia

Object

Attribute

ReturnValueNameAttribute

Atributos

AttributeUsageAttribute

Comentarios

En un componente de Windows Runtime, todos los parámetros de un método y el valor devuelto deben tener nombres. De forma predeterminada, Winmdexp.exe (herramienta de exportación de metadatos de Windows Runtime) proporciona al valor devuelto el nombre "value". Cuando usas un componente en una aplicación de la Tienda Windows 8.x escrita en JavaScript, puedes usar este nombre para recuperar el valor devuelto. Por ejemplo, supongamos que un componente define un método que tiene un valor devuelto y dos parámetros out (ByRef parámetros con el atributo 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

Al llamar a la función desde JavaScript, puede acceder al valor devuelto por su nombre predeterminado (value):

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

Debe asignar al valor devuelto un nombre diferente si ya tiene un parámetro denominado "value". O puede que simplemente quiera usar un nombre más significativo (por ejemplo, "promedio" en este ejemplo). Aplique el ReturnValueNameAttribute atributo al método y especifique un nuevo nombre.

[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

Constructores

Nombre	Description
ReturnValueNameAttribute(String)	Inicializa una nueva instancia de la ReturnValueNameAttribute clase y especifica el nombre del valor devuelto.

Propiedades

Nombre	Description
Name	Obtiene el nombre especificado para el valor devuelto de un método en un componente de Windows Runtime.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Nombre	Description
Equals(Object)	Devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Cuando se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se reemplaza en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)