ReadOnlyArrayAttribute Class

Definition

Namespace:

System.Runtime.InteropServices.WindowsRuntime

Assembly:

System.Runtime.InteropServices.WindowsRuntime.dll

When applied to an array parameter in a Windows Runtime component, specifies that the contents of the array that is passed to that parameter are used only for input. The caller expects the array to be unchanged by the call.

public ref class ReadOnlyArrayAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=false)]
public sealed class ReadOnlyArrayAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=false)>]
type ReadOnlyArrayAttribute = class
    inherit Attribute

Public NotInheritable Class ReadOnlyArrayAttribute
Inherits Attribute

Inheritance

Object

Attribute

ReadOnlyArrayAttribute

Attributes

AttributeUsageAttribute

Remarks

If an array parameter in your Windows Runtime component is passed by value (ByVal in Visual Basic), you must apply one of the following attributes to it:

• Apply the ReadOnlyArrayAttribute attribute if you intend the contents of the array to be used for input only.

• 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. 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.

Important

Parameters that have the ReadOnlyArrayAttribute attribute behave differently depending on whether the caller is written in native code or managed code. If the caller is native code (JavaScript or Visual C++ component extensions), the array is copied when the call crosses the application binary interface (ABI) boundary. Elements are converted if necessary. Therefore, any accidental changes the method makes to an input-only array are not visible to the caller.

If the caller is managed code, the array is not copied. The original array is available to the called method, as it would be in any method call in the .NET Framework. Array contents are mutable in .NET Framework code, so any changes the method makes to the array are visible to the caller. This is important to remember because it affects unit tests written for a Windows Runtime component. If the tests are written in managed code, the contents of an array will appear to be mutable during testing.

Applying this attribute to a parameter that has the InAttribute or OutAttribute attribute causes an error when the module is exported. Applying the attribute to an out parameter also causes an error.

Constructors

ReadOnlyArrayAttribute()

Initializes a new instance of the ReadOnlyArrayAttribute class.

Properties

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• WriteOnlyArrayAttribute
• Winmdexp.exe (Windows Runtime Metadata Export Tool)
• Creating Windows Runtime Components in C# and Visual Basic
• Passing arrays to a Windows Runtime component