IAgentCharacterEx::SetHelpContextID

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

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, 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 diese in der HelpFile- eigenschaft des Zeichens festgelegt haben, ruft Der Microsoft-Agent automatisch Hilfe auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer das Zeichen 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 das Zeichen. Wenn in der HelpContextID--Eigenschaft eine Kontextnummer vorhanden ist, zeigt die Hilfe ein Thema an, das dem aktuellen Hilfekontext entspricht; andernfalls wird "Kein Hilfethema, das diesem Element zugeordnet ist" angezeigt.

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

Siehe auch

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