IAgentCommandsEx::GetHelpContextID

[Der Microsoft-Agent ist ab Windows 7 veraltet und kann in nachfolgenden Versionen von Windows nicht verfügbar sein.]

HRESULT GetHelpContextID(
   long * pulHelpID  // address of Commands object help topic ID
);

Ruft die HelpContextID- für ein Command -Objekt ab.

• Gibt S_OK zurück, um anzugeben, dass der Vorgang erfolgreich war.

pulHelpID-

Adresse einer Variablen, die die Kontextnummer des Hilfethemas für das Command-Objekt empfängt.

Wenn Sie eine Windows-Hilfedatei für Ihre Anwendung erstellt und die HelpFile- Eigenschaft des Zeichens festgelegt haben, ruft Der Microsoft-Agent automatisch Hilfe auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer Ihr Command-Objekt auswählt. Wenn in der HelpContextIDeine Kontextnummer vorhanden ist, ruft Agent Hilfe auf und sucht nach dem Thema, das durch die aktuelle Kontextnummer identifiziert wird. Die aktuelle Kontextnummer ist der Wert HelpContextID- für das Command-Objekt.

Diese Eigenschaft gilt nur für die Verwendung des Zeichens ihrer Clientanwendung; Die Einstellung wirkt sich nicht auf andere Clients des Zeichens oder anderer Zeichen Ihrer Clientanwendung aus.

Siehe auch

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName