IAgentCommandEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

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

  • Gibt S _ OK zurück, um anzugeben, dass der Vorgang erfolgreich war.

pulID

Adresse einer Variablen, die die Kontextnummer des Hilfethemas empfängt, das dem Command-Objekt zugeordnet ist.

Wenn Sie eine Windows-Hilfedatei für Ihre Anwendung erstellt und die HelpFile-Eigenschaft Ihres Zeichens auf diese Datei festgelegt haben, ruft Microsoft Agent 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::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName