IAgentCommandsEx::SetHelpContextID

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

HRESULT SetHelpContextID(
   long ulHelpID  // ID for help topic
);

Establece helpContextID para un objeto Command .

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

ulHelpID

Número de contexto del tema de ayuda asociado al objeto Command ; se usa para proporcionar ayuda contextual para el comando .

Si ha creado un archivo de Ayuda de Windows para la aplicación y lo ha establecido en la propiedad HelpFile del carácter. El agente llama automáticamente a La Ayuda cuando HelpModeOn está establecido en True y el usuario selecciona el comando. Si hay un número de contexto en 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. Si hay un número de contexto en la propiedad HelpContextID del comando seleccionado, la Ayuda muestra un tema correspondiente al contexto de ayuda actual; de lo contrario, muestra "No hay ningún tema de Ayuda asociado a este elemento".

Esta propiedad solo se aplica al uso del carácter de la aplicación cliente; la configuración no afecta a otros clientes del carácter u otros caracteres de la aplicación cliente.

Nota:

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

 

Consulte también

IAgentCommandsEx::GetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName