IAgentCharacterEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

Recupera helpContextID per il carattere.

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

pulHelpID

Indirizzo di una variabile che riceve il numero di contesto dell'argomento 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 seleziona il carattere. Se è presente un numero di contesto in HelpContextID, Agent 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.

IAgentCharacterEx::GetHelpContextID restituisce l'HelpContextID impostato per il carattere. Non restituisce helpContextID impostato da altri client.

Nota

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

 

Vedere anche

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