IAgentCommandEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

Ruft die HelpContextID- für ein Command -Objekt ab.

• Gibt S_OK zurück, um anzugeben, dass der Vorgang erfolgreich war.

pulID-

Adresse einer Variablen, die die Kontextnummer des Hilfethemas empfängt, das dem Command-Objekt zugeordnet ist.

Wenn Sie eine Windows-Hilfedatei für Ihre Anwendung erstellt und die HelpFile-Eigenschaft ihres Zeichens auf diese Datei festgelegt haben, ruft Microsoft Agent automatisch Hilfe auf, wenn HelpModeOn- auf True festgelegt ist und der Benutzer den Befehl 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 den Befehl.

Anmerkung

Zum Erstellen einer Hilfedatei ist der Microsoft Windows-Hilfecompiler erforderlich.

 

Siehe auch

IAgentCommandEx::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName