IAgentCharacterEx::GetHelpFileName

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

HRESULT GetHelpFileName(
   BSTR * pbszName  // address of Help filename
);

Recupera helpFileName per un carattere.

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

pbszName

Indirizzo di una variabile che riceve il nome file della Guida per il carattere.

Se è stato creato un file della Guida di Windows per l'applicazione e si imposta la proprietà HelpFile del carattere, Microsoft Agent chiama automaticamente la Guida quando HelpModeOn è impostato su True e l'utente fa clic sul carattere o seleziona un comando dal relativo menu a comparsa. Se nella proprietà HelpContextID del comando selezionato è presente un numero di contesto, nella Guida viene visualizzato un argomento corrispondente al contesto corrente della Guida; in caso contrario, viene visualizzato "Nessun argomento della Guida associato a questo elemento".

Questa proprietà si applica solo all'uso del carattere dell'applicazione client; l'impostazione non influisce su altri client del carattere o di altri caratteri dell'applicazione client.

Nota

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

 

Vedere anche

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