ReturnValueNameAttribute Classe

Definição

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