IAgentCharacterEx::SetHelpContextID

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Imposta HelpContextID per il carattere.

• Restituisce S_OK per indicare che l'operazione è riuscita.

ulHelpID

Numero di contesto dell'argomento della Guida per associato a un carattere; usato per fornire la Guida sensibile al contesto per il carattere.

Se è stato creato un file della Guida di Windows per l'applicazione e impostarlo nella proprietà HelpFile del carattere, Microsoft Agent chiama automaticamente La Guida quando HelpModeOn è impostato su True e l'utente seleziona il carattere. Se è presente un numero di contesto nella GuidaContextID, l'agente chiama La Guida e cerca l'argomento identificato dal numero di contesto corrente. Il numero di contesto corrente è il valore di HelpContextID per il carattere. Se nella proprietà HelpContextID è presente un numero di contesto, la Guida visualizza un argomento corrispondente al contesto corrente della Guida; in caso contrario, viene visualizzato "Nessun argomento della Guida associato a questo elemento".

Questa impostazione si applica solo quando l'applicazione client è il client attivo del carattere superiore. Non influisce su altri client del carattere o di altri caratteri usati dall'applicazione client.

Nota

La creazione di un file della Guida richiede il compilatore della Guida di Microsoft Windows.

 

Vedere anche

IAgentCharacterEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName