IAgentCharacterEx::SetHelpFileName

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

HRESULT SetHelpFileName(
   BSTR bszName  // Help filename
);

Legt den 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 automatisch Hilfe auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer auf das Zeichen klickt oder einen Befehl im Popupmenü auswählt. Wenn in der HelpContextID Eigenschaft des ausgewählten Befehls 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 Eigenschaft gilt nur für die Verwendung des Zeichens ihrer Clientanwendung; Die Einstellung wirkt sich nicht auf andere Clients des Zeichens oder anderer Zeichen Ihrer Clientanwendung aus.

Siehe auch

IAgentCommandsEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::GetHelpFileName