ReturnValueNameAttribute 类

定义

命名空间:

System.Runtime.InteropServices.WindowsRuntime

程序集:

System.Runtime.InteropServices.WindowsRuntime.dll

程序集:

mscorlib.dll

指定 Windows 运行时组件中方法的返回值名称。

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 参数 OutAttribute 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  

从 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" 的参数，则必须为返回值指定不同的名称。 或者，您可能只想使用一个更有意义的名称 (例如，在此示例) 中为 "平均值"。 将特性应用于 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  

构造函数

ReturnValueNameAttribute(String)

初始化 ReturnValueNameAttribute 类的新实例，并指定返回值的名称。

属性

Name	获取为 Windows 运行时组件中方法的返回值指定的名称。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	将一组名称映射为对应的一组调度标识符。 (继承自 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	检索对象的类型信息，然后可以使用该信息获取接口的类型信息。 (继承自 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	检索对象提供的类型信息接口的数量（0 或 1）。 (继承自 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	提供对某一对象公开的属性和方法的访问。 (继承自 Attribute)

另请参阅

• 用 C# 和 Visual Basic 创建 Windows 运行时组件