IAgentCharacterEx::SetHelpContextID

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

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

Legt die HelpContextID für das Zeichen fest.

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

ulHelpID

Die Kontextnummer des Hilfethemas für , das einem Zeichen zugeordnet ist. wird verwendet, um kontextbezogene Hilfe für das Zeichen bereitzustellen.

Wenn Sie eine Windows Hilfedatei für Ihre Anwendung erstellt und in der HelpFile-Eigenschaft des Zeichens festgelegt haben, ruft der Microsoft-Agent automatisch Help auf, wenn HelpModeOn auf True festgelegt ist und der Benutzer das Zeichen 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 Zeichen. Wenn die HelpContextID-Eigenschaft eine Kontextnummer enthält, zeigt die Hilfe ein Thema an, das dem aktuellen Hilfekontext entspricht. Andernfalls wird "Diesem Element ist kein Hilfethema zugeordnet" angezeigt.

Diese Einstellung gilt nur, wenn Ihre Clientanwendung der aktive Client des obersten Zeichens ist. Sie wirkt sich nicht auf andere Clients des Zeichens oder andere Zeichen aus, die ihre Clientanwendung verwendet.

Hinweis

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

Weitere Informationen

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