DispIdAttribute-Klasse

Artikel
04/20/2017

Veröffentlicht: Oktober 2016

Gibt die COM-Dispatch-ID (DISPID) einer Methode, eines Felds oder einer Eigenschaft an.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

Vererbungshierarchie

System.Object
System.Attribute
System.Runtime.InteropServices.DispIdAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event, 
    Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class DispIdAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Method | AttributeTargets::Property | AttributeTargets::Field | AttributeTargets::Event, 
    Inherited = false)]
[ComVisibleAttribute(true)]
public ref class DispIdAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event,
    Inherited = false)>]
[<ComVisibleAttribute(true)>]
type DispIdAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Method Or AttributeTargets.Property Or AttributeTargets.Field Or AttributeTargets.Event,
    Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class DispIdAttribute
    Inherits Attribute

Konstruktoren

	Name	Beschreibung
	DispIdAttribute(Int32)	Initialisiert eine neue Instanz der DispIdAttribute -Klasse mit der angegebenen DISPID.

Eigenschaften

	Name	Beschreibung
	TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.(Geerbt von „Attribute“.)
	Value	Ruft die DISPID für das Element ab.

Methoden

	Name	Beschreibung
	Equals(Object)	Diese API unterstützt die Produkt Infrastruktur und sollte nicht direkt aus dem Code verwendet werden. Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.(Geerbt von „Attribute“.)
	GetHashCode()	Gibt den Hashcode für diese Instanz zurück.(Geerbt von „Attribute“.)
	GetType()	Ruft den Type der aktuellen Instanz ab.(Geerbt von „Object“.)
	IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.(Geerbt von „Attribute“.)
	Match(Object)	Ruft beim Überschreiben in einer abgeleiteten Klasse gibt einen Wert, der angibt, ob diese Instanz gleich ein angegebenen Objekt ist.(Geerbt von „Attribute“.)
	ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.(Geerbt von „Object“.)

Explizite Schnittstellenimplementierungen

	Name	Beschreibung
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.(Geerbt von „Attribute“.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.(Geerbt von „Attribute“.)
	_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).(Geerbt von „Attribute“.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.(Geerbt von „Attribute“.)

Hinweise

You can apply this attribute to methods, fields, or properties.

This attribute contains the DISPID for the method, field, or property it describes. Unique DISPIDs are typically assigned by the common language runtime, but you can use this attribute to assign a specific DISPID to a method. When importing a type library, this attribute is applied to all methods with assigned DISPIDs. This ensures that any managed implementation of the same method retains the same DISPID if exposed to COM.

See DISPID Constantshttps://msdn.microsoft.com/library/windows/desktop/ms221242(v=vs.85).aspx for a list of commonly used DISPID values.

Beispiele

The following example demonstrates how explicit DISPIDs can be assigned to members of a class.

using System.Runtime.InteropServices;

public class MyClass
{
   public MyClass() {}

   [DispId(8)]
   public void MyMethod() {}

   public int MyOtherMethod() {
      return 0;
   }

   [DispId(9)]
   public bool MyField;
}

Imports System.Runtime.InteropServices

Class SampleClass

    Public Sub New()
        'Insert code here.
    End Sub

    <DispIdAttribute(8)> _ 
    Public Sub MyMethod()
        'Insert code here.
    End Sub    

    Public Function MyOtherMethod() As Integer
        'Insert code here.
        Return 0
    End Function

    <DispId(9)> _
    Public MyField As Boolean
End Class

using namespace System::Runtime::InteropServices;
public ref class MyClass
{
public:
   MyClass(){}


   [DispId(8)]
   void MyMethod(){}

   int MyOtherMethod()
   {
      return 0;
   }


   [DispId(9)]
   bool MyField;
};

Versionsinformationen

Universelle Windows-Plattform
Verfügbar seit 8
.NET Framework
Verfügbar seit 1.1
Portierbare Klassenbibliothek
Unterstützt in: portierbare .NET-Plattformen
Silverlight
Verfügbar seit 2.0
Windows Phone Silverlight
Verfügbar seit 7.0
Windows Phone
Verfügbar seit 8.1

Threadsicherheit

Alle öffentlichen statischen Member ( Shared in Visual Basic) dieses Typs sind threadsicher. Die Threadsicherheit für Instanzmember ist nicht garantiert.

Siehe auch

System.Runtime.InteropServices-Namespace

Zurück zum Anfang

Freigeben über