IAgentCommandEx::SetHelpContextID

[Microsoft Agent ist ab Version Windows 7 veraltet und in nachfolgenden Versionen von Windows.]

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 kontextsensitive Hilfe für den Befehl zur Verfügung zu stellen.

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

Hinweis

Zum Erstellen einer Hilfedatei ist der Microsoft Windows Help Compiler erforderlich.

Weitere Informationen

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