ReturnValueNameAttribute 類別

定義

命名空間:

System.Runtime.InteropServices.WindowsRuntime

組件:

System.Runtime.InteropServices.WindowsRuntime.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 Store 應用程式中使用元件時，您可以使用此名稱來擷取傳回值。 例如，假設元件會定義傳回值的方法，並在Visual Basic中定義具有 OutAttribute 屬性的兩out個參數 (ByRef 參數) ：

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)

另請參閱

• 在 C++ 和 Visual Basic 中建立 Windows 執行階段元件