IAccessible::get_accHelpTopic-Methode (oleacc.h)

Die IAccessible::get_accHelpTopic-Methode ruft den vollständigen Pfad der WinHelp-Datei ab, die dem angegebenen Objekt zugeordnet ist. Außerdem wird der Bezeichner des entsprechenden Themas in dieser Datei abgerufen. Diese Eigenschaft wird nicht von allen Objekten unterstützt. Diese Eigenschaft wird selten von Anwendungen unterstützt oder verwendet.

Hinweis: IAccessible::get_accHelpTopic ist veraltet und sollte nicht verwendet werden.

 

Syntax

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

Parameter

[out] pszHelpFile

Typ: BSTR*

Adresse eines BSTR , der den vollständigen Pfad der WinHelp-Datei empfängt, die dem angegebenen Objekt zugeordnet ist.

[in] varChild

Typ: VARIANT

Gibt an, ob das abgerufene Hilfethema zum Objekt oder zu einem der untergeordneten Elemente des Objekts gehört. Dieser Parameter ist entweder CHILDID_SELF (um ein Hilfethema für das Objekt abzurufen) oder eine untergeordnete ID (um ein Hilfethema für eines der untergeordneten Elemente des Objekts abzurufen). Weitere Informationen zum Initialisieren von VARIANT finden Sie unter Verwenden untergeordneter IDs in Parametern.

pidTopic

Typ: long*

[out, retval] Adresse einer Variablen, die das Dem angegebenen Objekt zugeordnete Hilfedateithema identifiziert. Dieser Wert wird als Kontextbezeichner des gewünschten Themas verwendet, das an die WinHelp-Funktion übergeben wird. Legen Sie beim Aufrufen von WinHelp zum Anzeigen des Themas den uCommand-Parameter auf HELP_CONTEXT fest, wandeln Sie den Wert, auf den pidTopic verweist, in ein DWORD um, und übergeben Sie ihn als dwData-Parameter .

Rückgabewert

Typ: HRESULT

Gibt bei Erfolg S_OK zurück.

Wenn dies nicht erfolgreich ist, gibt einen der Werte in der folgenden Tabelle oder einen anderen COM-Standardfehlercode zurück. Server geben diese Werte zurück, aber Clients müssen ausgabeparameter immer überprüfen, um sicherzustellen, dass sie gültige Werte enthalten. Weitere Informationen finden Sie unter Überprüfen von IAccessible-Rückgabewerten.

Fehler	BESCHREIBUNG
S_FALSE	Es sind keine Hilfeinformationen verfügbar.
E_INVALIDARG	Ein Argument ist ungültig.
DISP_E_MEMBERNOTFOUND	Diese Eigenschaft wird vom Objekt nicht unterstützt.

Hinweise

Das Abrufen von Informationen aus einer Hilfedatei kann zeit- und arbeitsspeicherintensiv sein.

Hinweis für Serverentwickler: Diese Eigenschaft bietet Zugriff auf ein Hilfethema in WinHelp, während IAccessible::get_accHelp eine Zeichenfolge zurückgibt. Objekte sind nicht erforderlich, um IAccessible::get_accHelp und IAccessible::get_accHelpTopic zu unterstützen, aber sie müssen mindestens eine unterstützen. Wenn sie problemlos eine Zeichenfolge zurückgeben können, müssen sie IAccessible::get_accHelp unterstützen. andernfalls muss IAccessible::get_accHelpTopic unterstützt werden. Wenn beides unterstützt wird, stellt IAccessible::get_accHelpTopic ausführlichere Informationen bereit.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	oleacc.h
Bibliothek	Oleacc.lib
DLL	Oleacc.dll
Verteilbare Komponente	Active Accessibility 1.3 RDK unter Windows NT 4.0 mit SP6 und höher und Windows 95

Weitere Informationen

HelpTopic-Eigenschaft

Iaccessible

IAccessible::get_accHelp