Compartir a través de

IAgentCharacterEx::SetHelpContextID

  • Artículo

[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 el carácter.

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

ulHelpID

Número de contexto del tema de ayuda para asociado a un carácter; se usa para proporcionar ayuda contextual para el carácter.

Si ha creado un archivo de Ayuda de Windows para la aplicación y lo ha establecido en la propiedad HelpFile del carácter, Microsoft Agent llama automáticamente a La Ayuda cuando HelpModeOn está establecido en True y el usuario selecciona el carácter. Si hay un número de contexto en HelpContextID, el Agente llama a la 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 carácter. Si hay un número de contexto en la propiedad HelpContextID , 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 configuración solo se aplica cuando la aplicación cliente es el cliente activo del carácter superior. No afecta a otros clientes del carácter u otros caracteres que usa la aplicación cliente.

Nota

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

 

Consulte también

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