ReturnValueNameAttribute ReturnValueNameAttribute ReturnValueNameAttribute ReturnValueNameAttribute Class

Definición

Especifica el nombre del valor devuelto de un método en un componente Windows Runtime.Specifies the name of the return value of a method in a Windows Runtime component.

public ref class ReturnValueNameAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)]
public sealed class ReturnValueNameAttribute : Attribute
type ReturnValueNameAttribute = class
    inherit Attribute
Public NotInheritable Class ReturnValueNameAttribute
Inherits Attribute
Herencia
ReturnValueNameAttributeReturnValueNameAttributeReturnValueNameAttributeReturnValueNameAttribute
Atributos

Comentarios

En un Windows en tiempo de ejecuciónWindows Runtime componente de, todos los parámetros de un método y el valor devuelto deben tener nombres.In a Windows en tiempo de ejecuciónWindows Runtime component, all the parameters of a method and the return value must have names. De forma predeterminada, Winmdexp. exe (Windows Runtime herramienta de exportación de metadatos) proporciona el valor devuelto con el nombre "Value".By default, Winmdexp.exe (Windows Runtime Metadata Export Tool) gives the return value the name "value". Cuando se usa un componente en una Tienda Windows 8.xWindows 8.x Store aplicación escrita en JavaScript, se puede usar este nombre para recuperar el valor devuelto.When you use a component in a Tienda Windows 8.xWindows 8.x Store app written in JavaScript, you can use this name to retrieve the return value. Por ejemplo, supongamos que un componente define un método que tiene un valor out devueltoByRef y dos parámetros OutAttribute (parámetros con el atributo en Visual Basic):For example, suppose a component defines a method that has a return value and two out parameters (ByRef parameters with the OutAttribute attribute in 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  
  

Cuando se llama a la función desde JavaScript, se puede tener acceso al valor devuelto mediante suvaluenombre predeterminado ():When you call the function from JavaScript, you can access the return value by its default name (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 un nombre diferente al valor devuelto si ya tiene un parámetro denominado "valor". O bien, puede que simplemente desee usar un nombre más significativo (como "Average" en este ejemplo).Or you might simply want to use a more meaningful name (such as "average" in this example). Aplique el ReturnValueNameAttribute atributo al método y especifique un nuevo nombre.Apply the ReturnValueNameAttribute attribute to your method and specify a new name.

[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

ReturnValueNameAttribute(String) ReturnValueNameAttribute(String) ReturnValueNameAttribute(String) ReturnValueNameAttribute(String)

Inicializa una nueva instancia de la clase ReturnValueNameAttribute con y especifica el nombre del valor devuelto.Initializes a new instance of the ReturnValueNameAttribute class, and specifies the name of the return value.

Propiedades

Name Name Name Name

Obtiene el nombre que se especificó para el valor devuelto de un método en un componente de Windows en tiempo de ejecuciónWindows Runtime.Gets the name that was specified for the return value of a method in a Windows en tiempo de ejecuciónWindows Runtime component.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: