ReturnValueNameAttribute Classe

Definição

Namespace:

System.Runtime.InteropServices.WindowsRuntime

Assembly:

System.Runtime.InteropServices.WindowsRuntime.dll

Especifica o nome do valor retornado de um método em um componente 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

Herança

Object

Attribute

ReturnValueNameAttribute

Atributos

AttributeUsageAttribute

Comentários

Em um componente Windows Runtime, todos os parâmetros de um método e o valor retornado devem ter nomes. Por padrão, Winmdexp.exe (Windows Runtime Ferramenta de Exportação de Metadados) fornece ao valor retornado o nome "valor". Ao usar um componente em um aplicativo da Loja Windows 8.x escrito em JavaScript, você pode usar esse nome para recuperar o valor retornado. Por exemplo, suponha que um componente defina um método que tenha um valor retornado e dois parâmetros out (parâmetros ByRef com o atributo OutAttribute em 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

Ao chamar a função de JavaScript, você pode acessar o valor retornado pelo nome padrão (value):

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

Você deve dar ao valor retornado um nome diferente se já tiver um parâmetro chamado "valor". Ou você pode simplesmente querer usar um nome mais significativo (como "média" neste exemplo). Aplique o ReturnValueNameAttribute atributo ao método e especifique um novo nome.

[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

Construtores

Nome	Description
ReturnValueNameAttribute(String)	Inicializa uma nova instância da ReturnValueNameAttribute classe e especifica o nome do valor retornado.

Propriedades

Nome	Description
Name	Obtém o nome especificado para o valor retornado de um método em um componente Windows Runtime.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para esse Attribute. (Herdado de Attribute)

Métodos

Nome	Description
Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash dessa instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)