IAgentCommandEx::GetHelpContextID

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

HRESULT GetHelpContextID(
   long * pulID  //  address of command's help topic ID
);

Recupera ilHelpContextIDper un oggettoCommand.

• Restituisce S_OK per indicare che l'operazione è stata completata correttamente.

pulID

Indirizzo di una variabile che riceve il numero di contesto dell'argomento della Guida associato all'oggettocommand.

Se è stato creato un file della Guida di Windows per l'applicazione e si imposta la proprietàhelpfiledel carattere su questo file, Microsoft Agent chiama automaticamente la Guida quando HelpModeOn è impostato su True e l'utente seleziona il comando. Se è presente un numero di contesto nel 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 comando.

Nota

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

 

Vedere anche

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