IAgentCommandsEx::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 un oggetto Command .

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

ulHelpID

Numero di contesto dell'argomento della Guida associato all'oggetto Command ; usato per fornire la Guida sensibile al contesto per il comando.

Se hai creato un file della Guida di Windows per l'applicazione e imposta questo file nella proprietà HelpFile del carattere. Agent chiama automaticamente la Guida quando HelpModeOn è impostato su True e l'utente seleziona il comando. 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 comando. 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::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName