SafeArrayDefaultRankAttribute Class

  • Article

Defines the default rank of an array.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Parameter Or AttributeTargets.ReturnValue, AllowMultiple := False,  _
    Inherited := False)> _
Public NotInheritable Class SafeArrayDefaultRankAttribute _
    Inherits Attribute

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

The SafeArrayDefaultRankAttribute type exposes the following members.

Constructors

  Name Description
Public method SafeArrayDefaultRankAttribute Initializes a new instance of the SafeArrayDefaultRankAttribute class with a default rank.

Top

Properties

  Name Description
Public property DefaultRank Gets the default rank of the array.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method 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.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

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.

See Also

Reference

Microsoft.VisualStudio.Tools.Applications.Runtime Namespace