IAgentCommandsEx::GetHelpContextID

[Der Microsoft-Agent ist ab Windows 7 veraltet und in nachfolgenden Versionen von Windows möglicherweise nicht mehr verfügbar.]

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 die Hilfe automatisch auf, wenn HelpModeOn auf True festgelegt ist und der Benutzer Ihr Command-Objekt 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 das Command-Objekt.

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

Hinweis

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

Weitere Informationen

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