ITypeLib::GetDocumentation-Methode (oaidl.h)

Artikel
02/29/2024

Ruft die Dokumentationszeichenfolge für die Bibliothek, den vollständigen Namen und Pfad der Hilfedatei sowie den Kontextbezeichner für das Hilfethema der Bibliothek in der Hilfedatei ab.

Syntax

HRESULT GetDocumentation(
  [in]  INT   index,
  [out] BSTR  *pBstrName,
  [out] BSTR  *pBstrDocString,
  [out] DWORD *pdwHelpContext,
  [out] BSTR  *pBstrHelpFile
);

Parameter

[in] index

Der Index der Typenbeschreibung, deren Dokumentation zurückgegeben werden soll. Wenn index -1 ist, wird die Dokumentation für die Bibliothek selbst zurückgegeben.

[out] pBstrName

Der Name des angegebenen Elements. Wenn der Aufrufer den Elementnamen nicht benötigt, kann pBstrName NULL sein.

[out] pBstrDocString

Die Dokumentationszeichenfolge für das angegebene Element. Wenn der Aufrufer die Dokumentationszeichenfolge nicht benötigt, kann pBstrDocString null sein.

[out] pdwHelpContext

Der Hilfekontextbezeichner (ID), der dem angegebenen Element zugeordnet ist. Wenn der Aufrufer die Hilfekontext-ID nicht benötigt, kann pdwHelpContext NULL sein.

[out] pBstrHelpFile

Der vollqualifizierte Name der Hilfedatei. Wenn der Aufrufer den Namen der Hilfedatei nicht benötigt, kann pBstrHelpFile NULL sein.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
S_OK	Erfolg.
E_INVALIDARG	Mindestens eines der Argumente ist ungültig.
STG_E_INSUFFICIENTMEMORY	Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.

Hinweise

Der Aufrufer sollte die Parameter pBstrName, pBstrDocString und pBstrHelpFile freigeben.

Anforderungen

Anforderung	Wert
Zielplattform	Windows
Kopfzeile	oaidl.h

Weitere Informationen

Itypelib

Freigeben über