ReturnValueNameAttribute ReturnValueNameAttribute ReturnValueNameAttribute ReturnValueNameAttribute Class

Определение

Задает имя возвращаемого значения метода в компоненте среды выполнения Windows.Specifies the name of the return value of a method in a Windows Runtime component.

public ref class ReturnValueNameAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Delegate | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)]
public sealed class ReturnValueNameAttribute : Attribute
type ReturnValueNameAttribute = class
    inherit Attribute
Public NotInheritable Class ReturnValueNameAttribute
Inherits Attribute
Наследование
ReturnValueNameAttributeReturnValueNameAttributeReturnValueNameAttributeReturnValueNameAttribute
Атрибуты

Комментарии

В Среда выполнения WindowsWindows Runtime компонент, все параметры метода и возвращаемое значение должны иметь имена.In a Среда выполнения WindowsWindows Runtime component, all the parameters of a method and the return value must have names. По умолчанию Winmdexp.exe (Windows Runtime Metadata Export Tool) присваивает возвращаемому значению имя «value».By default, Winmdexp.exe (Windows Runtime Metadata Export Tool) gives the return value the name "value". При использовании компонента в Магазин Windows 8.xWindows 8.x Store приложения, написанного на JavaScript, это имя можно использовать для получения возвращаемого значения.When you use a component in a Магазин Windows 8.xWindows 8.x Store app written in JavaScript, you can use this name to retrieve the return value. Предположим, например, компонент определяет метод, который имеет возвращаемое значение и два out параметров (ByRef параметров с OutAttribute атрибут в Visual Basic):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» в этом примере). Применить 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(String) ReturnValueNameAttribute(String) ReturnValueNameAttribute(String)

Инициализирует новый экземпляр класса ReturnValueNameAttribute и указывает имя возвращаемого значения.Initializes a new instance of the ReturnValueNameAttribute class, and specifies the name of the return value.

Свойства

Name Name Name Name

Получает имя, указанное для возвращаемого значения метода в компоненте Среда выполнения WindowsWindows Runtime.Gets the name that was specified for the return value of a method in a Среда выполнения WindowsWindows Runtime component.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

При переопределении в производном классе показывает, является ли значение данного экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

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

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

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

Дополнительно