ReturnValueNameAttribute 类

定义

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

继承

Object

Attribute

ReturnValueNameAttribute

属性

AttributeUsageAttribute

注解

在Windows 运行时组件中，方法和返回值的所有参数都必须具有名称。 默认情况下，Winmdexp.exe（Windows 运行时元数据导出工具）为返回值命名为“value”。 在用 JavaScript 编写的 Windows 8.x 应用商店应用中使用组件时，可以使用此名称来检索返回值。 例如，假设组件定义了一个返回值和两个out参数的方法（ByRef参数，Visual Basic中的 OutAttribute 属性）：

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

从 JavaScript 调用函数时，可以通过其默认名称value（）：

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

如果已有名为“value”的参数，则必须为返回值提供其他名称。 或者，你可能只想使用更有意义的名称（如此示例中的“average”）。 将 ReturnValueNameAttribute 属性应用于方法并指定新名称。

[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