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 ストア アプリでコンポーネントを使用する場合は、この名前を使用して戻り値を取得できます。 たとえば、コンポーネントが戻り値と 2 つの out パラメーター (Visual Basic の OutAttribute 属性を持つ 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" という名前のパラメーターが既にある場合は、戻り値に別の名前を付ける必要があります。 または、よりわかりやすい名前 (この例では "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