ReturnValueNameAttribute クラス

定義

Windows ランタイム コンポーネント中のメソッドの戻り値の名前を指定します。Specifies the name of the return value of a method in a Windows Runtime component.

public ref class ReturnValueNameAttribute sealed : Attribute
public sealed class ReturnValueNameAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)]
public sealed class ReturnValueNameAttribute : Attribute
type ReturnValueNameAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)>]
type ReturnValueNameAttribute = class
    inherit Attribute
Public NotInheritable Class ReturnValueNameAttribute
Inherits Attribute
継承
ReturnValueNameAttribute
属性

注釈

コンポーネントでは、 Windows ランタイムWindows Runtime メソッドと戻り値のすべてのパラメーターに名前を指定する必要があります。In a Windows ランタイムWindows Runtime component, all the parameters of a method and the return value must have names. 既定では、 Winmdexp.exe (Windows ランタイムメタデータのエクスポートツール) によって、戻り値の名前は "value" になります。By default, Winmdexp.exe (Windows Runtime Metadata Export Tool) gives the return value the name "value". JavaScript で記述されたアプリでコンポーネントを使用する場合 Windows 8.x ストアWindows 8.x Store 、この名前を使用して戻り値を取得できます。When you use a component in a Windows 8.x ストアWindows 8.x Store app written in JavaScript, you can use this name to retrieve the return value. たとえば、コンポーネントが、戻り値と2つの out パラメーター ( ByRef Visual Basic の属性を持つパラメーター) を持つメソッドを定義するとし OutAttribute ます。For example, suppose a component defines a method that has a return value and two out parameters (ByRef parameters with the OutAttribute attribute in 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 ます。When you call the function from JavaScript, you can access the return value by its default name (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" など) を使用することもできます。Or you might simply want to use a more meaningful name (such as "average" in this example). 属性を ReturnValueNameAttribute メソッドに適用し、新しい名前を指定します。Apply the ReturnValueNameAttribute attribute to your method and specify a new name.

[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 クラスの新しいインスタンスを初期化して、戻り値の名前を指定します。Initializes a new instance of the ReturnValueNameAttribute class, and specifies the name of the return value.

プロパティ

Name

Windows ランタイムWindows Runtime コンポーネントでメソッドの戻り値に対して指定された名前を取得します。Gets the name that was specified for the return value of a method in a Windows ランタイムWindows Runtime component.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください