SafeArrayDefaultRankAttribute Class

Defines the default rank of an array.

Namespace: Microsoft.VisualStudio.Tools.Applications.Runtime
Assembly: Microsoft.VisualStudio.Tools.Applications.Runtime (in Microsoft.VisualStudio.Tools.Applications.Runtime.dll)

Inheritance Hierarchy

System::Object
System::Attribute
Microsoft.VisualStudio.Tools.Applications.Runtime::SafeArrayDefaultRankAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets::Parameter | AttributeTargets::ReturnValue, 
	AllowMultiple = false, Inherited = false)]
public ref class SafeArrayDefaultRankAttribute sealed : Attribute

Constructors

	Name	Description
	SafeArrayDefaultRankAttribute(Int32)	Initializes a new instance of the SafeArrayDefaultRankAttribute class with a default rank.

Properties

	Name	Description
	DefaultRank	Gets the default rank of the array.
	TypeId	(Inherited from Attribute.)

Methods

	Name	Description
	Equals(Object^)	(Inherited from Attribute.)
	GetHashCode()	(Inherited from Attribute.)
	GetType()	(Inherited from Object.)
	IsDefaultAttribute()	(Inherited from Attribute.)
	Match(Object^)	(Inherited from Attribute.)
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute::GetIDsOfNames(Guid%, IntPtr, UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute::GetTypeInfo(UInt32, UInt32, IntPtr)	(Inherited from Attribute.)
	_Attribute::GetTypeInfoCount(UInt32%)	(Inherited from Attribute.)
	_Attribute::Invoke(UInt32, Guid%, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	(Inherited from Attribute.)

For a host application that is based on COM, add the SafeArrayDefaultRankAttribute attribute in the proxy code to marshaled safe array parameters or return values to specify the actual rank of the arrays in question. This is needed because there is no differentiation between one-dimensional and multi-dimensional arrays in the COM type library. The COM safe arrays are converted to one-dimensional arrays in the proxy code by default. Also, use the SafeArrayDefaultRankAttribute attribute with parameters or return values of type Array or System.Object[] that do not convey rank information.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.