IAgentCharacterEx::SetHelpFileName
[Der Microsoft-Agent ist ab Windows 7 veraltet und in nachfolgenden Versionen von Windows möglicherweise nicht mehr verfügbar.]
HRESULT SetHelpFileName(
BSTR bszName // Help filename
);
Legt helpFileName für ein Zeichen fest.
- Gibt S _ OK zurück, um anzugeben, dass der Vorgang erfolgreich war.
-
bszName
-
Der Hilfedateiname für das Zeichen.
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 auf das Zeichen klickt oder einen Befehl im Popupmenü auswählt. Wenn die HelpContextID-Eigenschaft des ausgewählten Befehls 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 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::GetHelpFileName