ReturnValueNameAttribute クラス

リファレンス

定義

名前空間:: System.Runtime.InteropServices.WindowsRuntime

アセンブリ:: System.Runtime.InteropServices.WindowsRuntime.dll

アセンブリ:: mscorlib.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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 ストアアプリでコンポーネントを使用する場合は、この名前を使用して戻り値を取得できます。たとえば、コンポーネントが戻り値と 2 つの out パラメーター ( Visual Basic の属性を持つパラメーター)ByRef を持つメソッドを 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) でアクセスできます。

JavaScript

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

コンストラクター

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)

適用対象

製品	バージョン
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
UWP	10.0

こちらもご覧ください

C# および Visual Basic での Windows ランタイムコンポーネントの作成

次の方法で共有