ITypeInfo::GetDocumentation-Methode (oaidl.h)

  • Artikel

Ruft die Dokumentationszeichenfolge, den vollständigen Namen und Pfad der Hilfedatei sowie die Kontext-ID des Hilfethemas für eine angegebene Typenbeschreibung ab.

Syntax

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

Parameter

[in] memid

Die ID des Members, dessen Dokumentation zurückgegeben werden soll.

[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 Kontext der Hilfelokalisierung. Wenn der Aufrufer den Hilfekontext nicht benötigt, kann er NULL sein.

[out] pBstrHelpFile

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.
E_OUTOFMEMORY
Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.

Hinweise

Die Funktion GetDocumentation ermöglicht den Zugriff auf die Dokumentation für das durch den memid-Parameter angegebene Element. Wenn das übergebene Memid MEMBERID_NIL ist, wird die Dokumentation für die Typbeschreibung zurückgegeben.

Wenn die Typbeschreibung von einer anderen Typbeschreibung erbt, ist diese Funktion bei Bedarf rekursiv auf die Basistypbeschreibung, um das Element mit der angeforderten Member-ID zu finden.

Der Aufrufer sollte SysFreeString verwenden, um die von pBstrName, pBstrDocString und pBstrHelpFile referenzierten BSTRs frei zu geben.

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile oaidl.h

Weitere Informationen

Itypeinfo