IAgentCommandEx::GetHelpContextID

[Microsoft Agent está en desuso a partir de Windows 7 y puede no estar disponible en versiones posteriores de Windows].

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

Recupera elHelpContextID depara un objetoCommand de.

• Devuelve S_OK para indicar que la operación se realizó correctamente.

pulID

Dirección de una variable que recibe el número de contexto del tema de ayuda asociado al objetoCommand de.

Si ha creado un archivo de Ayuda de Windows para la aplicación y ha establecido la propiedad HelpFile de su carácter en este archivo, Microsoft Agent llama automáticamente a la Ayuda cuando helpModeOn se establece en True y el usuario selecciona el comando. Si hay un número de contexto en la HelpContextID, el agente llama a ayuda y busca el tema identificado por el número de contexto actual. El número de contexto actual es el valor de HelpContextID para el comando.

Nota

La creación de un archivo de Ayuda requiere el compilador de ayuda de Microsoft Windows.

 

Consulte también

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