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". При использовании компонента в приложении магазина Windows 8.x, написанном на JavaScript, это имя можно использовать для получения возвращаемого значения. Например, предположим, что компонент определяет метод с возвращаемым значением и двумя параметрами 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)