IAgentNotifySinkEx::HelpComplete

[Microsoft Agent è deprecato a partire da Windows 7 e potrebbe non essere disponibile nelle versioni successive di Windows.]

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

Notifica a un'applicazione client quando l'utente seleziona un comando o un carattere per completare la modalità Guida.

• Nessun valore restituito.

dwCharID

Identificatore del carattere per il quale è stata completata la modalità Guida.

dwCommandID

Identificatore del comando selezionato dall'utente.

dwCause

Causa dell'evento, che può essere il seguente:

valore	Descrizione
const unsigned short CSHELPCAUSE_COMMAND = 1;	L'utente ha selezionato un comando fornito dall'applicazione.
const unsigned short CSHELPCAUSE_OTHERPROGRAM = 2;	L'utente ha selezionato l'oggetto Commands di un altro client.
const unsigned short CSHELPCAUSE_OPENCOMMANDSWINDOW = 3;	L'utente ha selezionato il comando Apri comandi vocali.
const unsigned short CSHELPCAUSE_CLOSECOMMANDSWINDOW = 4;	L'utente ha selezionato il comando Chiudi comandi vocali.
const unsigned short CSHELPCAUSE_SHOWCHARACTER = 5;	L'utente ha selezionato il comando Show CharacterName.The user selected the Show CharacterName command.
const unsigned short CSHELPCAUSE_HIDECHARACTER = 6;	L'utente ha selezionato il comando Nascondi nome carattere .
const unsigned short CSHELPCAUSE_CHARACTER = 7;	L'utente ha selezionato (selezionato) il carattere.

In genere la modalità Guida viene completata quando l'utente fa clic o trascina il carattere o seleziona un comando dal menu a comparsa del carattere. Se si fa clic su un altro carattere o in un'altra posizione sullo schermo, la modalità Guida non viene annullata. Il client che imposta la modalità Guida per il carattere può annullare la modalità Guida impostando IAgentCharacter::HelpModeOn su False. (Questo non attiva il Evento IAgentNotifySinkEx::HelpComplete .

Quando l'utente seleziona un comando dal menu a comparsa del carattere in modalità Guida, il server rimuove il menu, chiama la Guida con l'helpContextID specificato del comando e invia questo evento. Sensibile al contesto (noto anche come What's This?) La finestra della Guida viene visualizzata nella posizione del puntatore. Se l'utente seleziona il comando in base all'input vocale, la finestra della Guida viene visualizzata sul carattere. Se il carattere è fuori schermo, la finestra viene visualizzata sullo schermo più vicina alla posizione corrente del carattere.

Se il server restituisce dwCommandID come stringa vuota (""), indica che l'utente ha selezionato un comando fornito dal server.

Questo evento viene inviato solo all'applicazione client che inserisce il carattere in modalità Guida.

Vedi anche

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