IAgentCommandsEx::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 Commands object help topic ID
);

Recupera helpContextID per un oggetto Command .

• 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 l'oggetto Command .

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 l'oggetto Command . 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 l'oggetto Command .

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 creazione di un file della Guida richiede il compilatore della Guida di Microsoft Windows.

 

Vedere anche

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