Freigeben über


Hinzufügen einer IDL-Eigenschaft

Der Assistent Hinzufügen einer IDL-Eigenschaft fügt eine Eigenschaft einer Schnittstelle hinzu, die in einer Schnittstellendefinitionsbibliothek (Interface Definition Library, IDL) definiert ist, z. B. in einem ATL-Projekt, das eine .idl-Datei enthält. Dieser Assistent ist in Projekten, die MFC unterstützen, nicht verfügbar.

Dieser Assistent unterscheidet sich vom Assistenten zum Hinzufügen von Eigenschaften und dem Assistenten zum Hinzufügen von IDL MFC-Eigenschaften folgendermaßen:

  • Der Assistent zum Hinzufügen von Eigenschaften fügt einer Schnittstelle in Ihrem Projekt eine Eigenschaft hinzu.
  • Der Assistent zum Hinzufügen von IDL MFC-Eigenschaften ist für MFC-, ActiveX- oder ATL-Projekte spezifisch, die MFC unterstützen.

So fügen Sie eine IDL-Eigenschaft hinzu

  1. Wählen Sie im Menü Ansicht die Option Klassenansicht aus.

  2. Klicken Sie in der Klassenansicht mit der rechten Maustaste auf den Namen der Schnittstelle, der die Eigenschaft hinzugefügt werden soll.

    Hinweis

    Sie können Eigenschaften auch zu Disp-Schnittstellen hinzufügen, die im Bibliotheksknoten geschachtelt sind, sofern das Projekt nicht attributiert ist.

  3. Klicken Sie mit der rechten Maustaste auf den Namen der Schnittstelle.

  4. Wählen Sie im Kontextmenü Hinzufügen>Eigenschaft hinzufügen aus.

  5. Geben Sie im Assistenten zum Hinzufügen von IDL-Eigenschaften die Informationen zum Erstellen der Eigenschaft an.

  6. Wählen Sie OK aus, um die Eigenschaft hinzuzufügen.

Die Methoden Get und Put der Eigenschaft werden in der Klassenansicht als zwei Symbole unter der Schnittstelle angezeigt, in der sie definiert sind. Doppelklicken Sie auf eines der Symbole, um die Eigenschaftsdeklaration in der .idl-Datei anzuzeigen.

Bei ATL-Schnittstellen werden die Get- und Put-Funktionen den .cpp- und .h-Dateien hinzugefügt.

Assistent zum Hinzufügen einer IDL-Eigenschaft

Im folgenden Abschnitt wird die Benutzeroberfläche beschrieben, die Sie zum Hinzufügen einer IDL-Eigenschaft verwenden:

Screenshot: Hinzufügen einer IDL-Eigenschaft mit zwei Parametern: „[in] int i“ und „[in] char c“; Rückgabetyp ist HRESULT; Eigenschaftstyp ist „float“

  • Eigenschaftenname

    Legt den Namen der Eigenschaft fest.

  • Eigenschaftentyp

    Der Datentyp der Eigenschaft.

  • Rückgabetyp

    Legt für ATL-Schnittstellen den Rückgabetyp für die Eigenschaft fest. Bei dualen Schnittstellen ist der Rückgabetyp immer HRESULT, und die Auswahloption ist nicht verfügbar. Bei benutzerdefinierten Schnittstellen können Sie einen Rückgabetyp aus der Liste auswählen. HRESULT wird dennoch empfohlen, weil dadurch ein Standardverfahren zum Zurückgeben von Fehlern bereitgestellt wird.

  • Get-Funktion

    Erstellt für ATL-Schnittstellen die Get-Methode zum Abrufen des Eigenschaftswerts. Wählen Sie Get oder Put oder beide aus.

  • Put-Funktion

    Erstellt für ATL-Schnittstellen die Put-Methode zum Festlegen des Eigenschaftswerts. Wählen Sie Get oder Put oder beide aus. Wenn Sie die Put-Funktion auswählen, können Sie die Methode auf die folgenden beiden Arten implementieren:

    Option BESCHREIBUNG
    propput Die PropPut-Funktion gibt eine Kopie des Objekts zurück. propput ist die Standardeinstellung und die gängigste Methode, um die Eigenschaft schreibbar zu machen.
    propputref Die PropPutRef-Funktion gibt einen Verweis auf das Objekt statt einer Kopie des Objekts zurück. Die Option propputref sollten Sie für Objekte (z. B. große Strukturen oder Arrays) verwenden, deren Initialisierung aufwändig sein kann.
  • Parameter

    Zeigt die Liste der Parameter an, die der Eigenschaft hinzugefügt werden. Jedes Element in der Liste besteht aus dem Parameternamen, dem Parametertyp und den Attributen.

    in gibt an, dass der Parameter von der aufrufenden Prozedur an die aufgerufene Prozedur übergeben wird. out gibt an, dass der Zeigerparameter von der aufgerufenen Prozedur an die aufrufende Prozedur zurückgegeben wird (vom Server an den Client).

  • +

    Fügen Sie einen Parameter hinzu. Geben Sie in Parameter den Parametertyp und den Namen ein. Beispiel: int x, und wählen Sie dann OK aus.

  • x

    Entfernen des ausgewählten Parameters aus Parameter.

  • Stiftsymbol

    Bearbeiten des ausgewählten Parameters.

  • Attribute

  1. helpcontext

    Gibt eine Kontext-ID an, die das Anzeigen von Informationen über diese Eigenschaft in der Hilfedatei ermöglicht. Weitere Informationen finden Sie unter helpcontext.

  2. helpstring

    Gibt eine Zeichenfolge an, die zum Beschreiben des Elements verwendet wird, auf das sie angewendet wird. Standardmäßig ist sie auf propertyEigenschaftenname gesetzt. Weitere Informationen finden Sie unter helpstring.

  3. id

    Legt den numerischen Bezeichner fest, der die Eigenschaft identifiziert. Diese Option ist nicht für Eigenschaften von benutzerdefinierten Schnittstellen verfügbar. Weitere Informationen finden Sie unter id.

  • Zusätzliche Attribute

Schlüsselwörter in der Microsoft Interface Definition Language (MIDL) werden ausführlich in der MIDL-Sprachreferenz beschrieben.

Option Beschreibung
bindable Gibt an, dass die Eigenschaft die Datenbindung unterstützt. Weitere Informationen finden Sie unter bindable.
defaultbind Gibt an, dass diese einzelne bindbare Eigenschaft das Objekt am besten darstellt. Weitere Informationen finden Sie unter defaultbind.
defaultcollelem Gibt an, dass die Eigenschaft eine Accessorfunktion für ein Element der Standardsammlung ist. Weitere Informationen finden Sie unter defaultcollelem.
displaybind Gibt an, dass diese Eigenschaft für den Benutzer als bindbar angezeigt werden soll. Weitere Informationen finden Sie unter displaybind.
hidden Gibt an, dass die Eigenschaft vorhanden ist, aber nicht in einem benutzerorientierten Browser angezeigt werden soll. Weitere Informationen finden Sie unter hidden.
immediatebind Gibt an, dass die Datenbank umgehend von allen an dieser Eigenschaft eines datengebundenen Objekts vorgenommenen Änderungen benachrichtigt wird. Weitere Informationen finden Sie unter immediatebind.
local Gibt für den MIDL-Compiler an, dass die Eigenschaft lokal ist. Weitere Informationen finden Sie unter local.
nonbrowsable Markiert einen Member einer Schnittstelle oder Disp-Schnittstelle, der nicht in einem Eigenschaftenbrowser angezeigt werden soll. Weitere Informationen finden Sie unter nonbrowsable.
requestedit Gibt an, dass die Eigenschaft die OnRequestEdit-Benachrichtigung unterstützt. Weitere Informationen finden Sie unter requestedit.
restricted Gibt an, dass die Eigenschaft nicht beliebig aufgerufen werden kann. Weitere Informationen finden Sie unter restricted.
source Gibt an, dass ein Member dieser Eigenschaft eine Ereignisquelle ist. Weitere Informationen finden Sie unter source.

Weitere Informationen

Hinzufügen einer Eigenschaft
Hinzufügen einer IDL-MFC-Eigenschaft