IAgentCommandEx::SetHelpContextID

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

HRESULT SetHelpContextID(
   long ulID  //  ID for help topic
);

Legt die HelpContextID- für ein Command-Objekt fest.

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

ulID-

Die Kontextnummer des Hilfethemas, das dem Command-Objekt zugeordnet ist; wird verwendet, um kontextbezogene Hilfe für den Befehl bereitzustellen.

Wenn Sie eine Windows-Hilfedatei für Ihre Anwendung erstellt haben und dies in der HelpFile-Eigenschaft des Zeichens festlegen. Der Microsoft-Agent ruft die Hilfe automatisch auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer den Befehl 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 den Befehl.

Anmerkung

Zum Erstellen einer Hilfedatei ist der Microsoft Windows-Hilfecompiler erforderlich.

 

Siehe auch

IAgentCommandEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName