ComAliasNameAttribute Class

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Source:

ComAliasNameAttribute.cs

Indicates the COM alias for a parameter or field type.

public ref class ComAliasNameAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, Inherited=false)]
public sealed class ComAliasNameAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue, Inherited=false)>]
type ComAliasNameAttribute = class
    inherit Attribute

Public NotInheritable Class ComAliasNameAttribute
Inherits Attribute

Inheritance

Object

Attribute

ComAliasNameAttribute

Attributes

AttributeUsageAttribute

Examples

In the following type library, OLE_COLOR is an alias for int. During import, the arguments of the Color accessor are marked with the ComAliasNameAttribute to indicate that type library refers to them as OLE_COLOR.

typedef int OLE_COLOR;    

interface Baz {  
 HRESULT SetColor([in] OLE_COLOR cl);  
 HRESULT GetColor([out, retval] OLE_COLOR *cl);  
}  

is imported as:

interface class Baz
{
   void SetColor( [ComAliasName("stdole.OLE_COLOR")]int cl );

   [returnvalue:ComAliasName("stdole.OLE_COLOR")]
   int GetColor();
};

interface Baz {
 void SetColor([ComAliasName("stdole.OLE_COLOR")] int cl);
 [return: ComAliasName("stdole.OLE_COLOR")] int GetColor();
}

Interface Baz
    Sub SetColor( <ComAliasName("stdole.OLE_COLOR")> cl As Integer)
    Function GetColor() As <ComAliasName("stdole.OLE_COLOR")> Integer
End Interface

Remarks

You can apply this attribute to parameters, fields, properties, or return values.

Constructors

ComAliasNameAttribute(String)

Initializes a new instance of the ComAliasNameAttribute class with the alias for the attributed field or parameter.

Properties

TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)
Value	Gets the alias for the field or parameter as found in the type library when it was imported.

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)