ReturnValueNameAttribute Класс

  • Ссылка

Определение

Пространство имен:
System.Runtime.InteropServices.WindowsRuntime
Сборка:
System.Runtime.InteropServices.WindowsRuntime.dll
Сборка:
mscorlib.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)

Явные реализации интерфейса

_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)

Применяется к

См. также раздел