WriteOnlyArrayAttribute Класс

Определение

При применении к параметру массива в компоненте среды выполнения Windows указывает, что содержимое массива, передаваемое этому параметру, используется только для вывода.When applied to an array parameter in a Windows Runtime component, specifies that the contents of an array that is passed to that parameter are used only for output. Вызывающая сторона не гарантирует, что содержимое инициализируется, и вызванный метод не должен считывать содержимое.The caller does not guarantee that the contents are initialized, and the called method should not read the contents.

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

Комментарии

Если параметр массива в Среда выполнения WindowsWindows Runtime компоненте передается по значению (ByVal в Visual Basic), необходимо применить к нему один из следующих атрибутов:If an array parameter in your Среда выполнения WindowsWindows Runtime component is passed by value (ByVal in Visual Basic), you must apply one of the following attributes to it:

  • Примените ReadOnlyArrayAttribute атрибут, если предполагается, что содержимое массива будет использоваться только для входных данных.Apply the ReadOnlyArrayAttribute attribute if you intend the contents of the array to be used for input only.

  • Примените WriteOnlyArrayAttribute атрибут, если предполагается, что содержимое массива будет использоваться только для вывода (то есть метод задает содержимое массива, но не считывает его).Apply the WriteOnlyArrayAttribute attribute if you intend the contents of the array to be used for output only (that is, the method sets the contents of the array but does not read them).

Применение обоих атрибутов к параметру приводит к ошибке.Applying both attributes to a parameter causes an error. Дополнительные сведения, включая стандартный шаблон для внесения изменений в массив, см. в разделе Передача массивов в компонент Среда выполнения Windows в центре разработки для Windows.For more information, including the standard pattern for making changes to an array, see Passing arrays to a Windows Runtime component in the Windows Dev Center.

Важно!

Параметры, имеющие WriteOnlyArrayAttribute атрибут, ведут себя по-разному в зависимости от того, написан ли вызывающий объект в машинном коде или управляемом коде.Parameters that have the WriteOnlyArrayAttribute attribute behave differently depending on whether the caller is written in native code or managed code. Если вызывающий объект является машинным кодом (расширения C++ JavaScript или Visual Component Extensions), вызываемый метод не может делать никаких предположений о содержимом исходного массива.If the caller is native code (JavaScript or Visual C++ component extensions), the called method can't make any assumptions about the contents of the original array. Например, массив, получаемый методом, может быть не инициализирован или может содержать значения по умолчанию.For example, the array the method receives might not be initialized, or might contain default values. Предполагается, что метод установит значения всех элементов в массиве.The method is expected to set the values of all the elements in the array.

Если вызывающий объект является управляемым кодом, исходный массив вызывающего объекта передается вызываемому методу, как в любом вызове метода в .NET Framework.If the caller is managed code, the caller's original array is passed to the called method, as it would be in any method call in the .NET Framework. Содержимое массива является изменяемым в управляемом коде, поэтому метод может выборочно считывать и изменять эти значения.Array contents are mutable in managed code, so the method can selectively read and change those values. Это важно помнить, поскольку это влияет на модульные тесты, написанные для компонента Среда выполнения WindowsWindows Runtime.This is important to remember because it affects unit tests written for a Среда выполнения WindowsWindows Runtime component. Если тесты написаны в управляемом коде, содержимое массива будет отображаться как изменяемое во время тестирования, а результаты, скорее всего, будут отличаться, если метод вызывается из машинного кода позже.If the tests are written in managed code, the contents of an array will appear to be mutable during testing, and the results are likely to be different if the method is called from native code later.

Применение этого атрибута к out параметру или к параметру, InAttribute имеющему атрибут, приводит к ошибке при экспорте модуля.Applying this attribute to an out parameter or to a parameter that has the InAttribute attribute causes an error when the module is exported. Применение атрибута к параметру, имеющему OutAttribute атрибут, вызывает ошибку, если у параметра не также есть модификатор Visual Basic. ByRefApplying the attribute to a parameter that has the OutAttribute attribute causes an error unless the parameter also has the Visual Basic ByRef modifier. В этом случае атрибут является избыточным, но разрешенным.In that case, the attribute is redundant but allowed.

Конструкторы

WriteOnlyArrayAttribute()

Инициализирует новый экземпляр класса WriteOnlyArrayAttribute.Initializes a new instance of the WriteOnlyArrayAttribute class.

Свойства

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)

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

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