ITypeLib2::GetDocumentation2-Methode (oaidl.h)

Artikel
02/29/2024

Ruft die Dokumentationszeichenfolge der Bibliothek, den vollständigen Dateinamen und Pfad der Hilfe, den zu verwendenden Lokalisierungskontext und die Kontext-ID des Hilfethemas der Bibliothek in der Hilfedatei ab.

Syntax

HRESULT GetDocumentation2(
  [in]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

Parameter

[in] index

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

[in] lcid

Der Gebietsschemabezeichner.

[out] pbstrHelpString

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

[out] pdwHelpStringContext

Der Kontext der Hilfelokalisierung. Wenn der Aufrufer den Hilfekontext nicht benötigt, kann er NULL sein.

[out] pbstrHelpStringDll

Der vollqualifizierte Name der Datei, die die DLL enthält, die für die Hilfedatei verwendet wird. Wenn der Aufrufer den Dateinamen nicht benötigt, kann er 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

Ruft Informationen auf Typbibliotheksebene ab. Der Aufrufer sollte die BSTR-Parameter freigeben.

Diese Funktion ruft _DLLGetDocumentation in der angegebenen DLL auf, um die gewünschte Hilfezeichenfolge abzurufen, wenn für dieses Element ein Hilfezeichenfolgenkontext vorhanden ist. Wenn kein Hilfezeichenfolgenkontext vorhanden ist oder ein Fehler auftritt, wird die GetDocumentation-Methode zurückgeschoben und die zugehörige Dokumentationszeichenfolge zurückgegeben.

Anforderungen

Anforderung	Wert
Zielplattform	Windows
Kopfzeile	oaidl.h

Weitere Informationen

ITypeLib2

Freigeben über