IAgentNotifySinkEx::HelpComplete

[Der Microsoft Agent ist seit Windows 7 veraltet und kann in späteren Versionen von Windows nicht mehr verfügbar sein.]

HRESULT HelpComplete(
   long dwCharID,     // character ID
   long dwCommandID,  // command ID
   long dwCause       // cause 
);

Benachrichtigt eine Clientanwendung, wenn der Benutzer einen Befehl oder einen Charakter auswählt, um den Hilfemodus abzuschließen.

• Kein Rückgabewert.

dwCharID

Bezeichner des Charakters, für den der Hilfemodus abgeschlossen wurde.

dwCommandID

Bezeichner des Befehls, den der Benutzer ausgewählt hat.

dwCause

Die Ursache für das Ereignis. Dabei kann es sich um die folgenden Werte handeln:

Wert	Beschreibung
const unsigned shortCSHELPCAUSE_COMMAND = 1;	Der Benutzer hat einen von Ihrer Anwendung bereitgestellten Befehl ausgewählt.
const unsigned shortCSHELPCAUSE_OTHERPROGRAM = 2;	Der Benutzer hat das Commands-Objekt eines anderen Clients ausgewählt.
const unsigned shortCSHELPCAUSE_OPENCOMMANDSWINDOW = 3;	Der Benutzer hat den Befehl „Open Voice Commands“ ausgewählt.
const unsigned shortCSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;	Der Benutzer hat den Befehl „Close Voice Commands“ ausgewählt.
const unsigned shortCSHELPCAUSE_SHOWCHARACTER = 5;	Der Benutzer hat den CharacterName-Befehl „Show“ ausgewählt.
const unsigned shortCSHELPCAUSE_HIDECHARACTER = 6;	Der Benutzer hat den CharacterName-Befehl „Hide“ ausgewählt.
const unsigned shortCSHELPCAUSE_CHARACTER = 7;	Der Benutzer hat den Charakter ausgewählt (angeklickt).

Normalerweise wird der Hilfemodus abgeschlossen, wenn der Benutzer auf den Charakter klickt oder ihn zieht oder einen Befehl aus dem Popupmenü des Charakters auswählt. Durch Klicken auf einen anderen Charakter oder auf eine andere Stelle auf dem Bildschirm wird der Hilfemodus nicht abgebrochen. Der Client, der den Hilfemodus für den Charakter festlegt, kann den Hilfemodus abbrechen, indem IAgentCharacter::HelpModeOn auf False festgelegt wird. (Dadurch wird das IAgentNotifySinkEx::HelpComplete-Ereignis nicht ausgelöst.)

Wenn der Benutzer einen Befehl aus dem Popupmenü des Charakters im Hilfemodus auswählt, entfernt der Server das Menü, ruft die Hilfe mit der angegebenen HelpContextID des Befehls auf und sendet dieses Ereignis. Das kontextsensitive Hilfefenster (auch „What's This?“ genannt) wird an der Zeigerposition angezeigt. Wenn der Benutzer den Befehl per Spracheingabe auswählt, wird das Hilfefenster über dem Charakter angezeigt. Wenn sich der Charakter außerhalb des Bildschirms befindet, wird das Fenster auf dem Bildschirm angezeigt, das der aktuellen Position des Charakters am nächsten ist.

Wenn der Server dwCommandID als leere Zeichenfolge ("") zurückgibt, gibt er an, dass der Benutzer einen vom Server bereitgestellten Befehl ausgewählt hat.

Dieses Ereignis wird nur an die Clientanwendung gesendet, die den Charakter im Hilfemodus platziert.

Weitere Informationen

IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName, IAgentCharacterEx::SetHelpContextID, IAgentCommandsEx::SetHelpContextID