Compartir a través de

IAgentCharacterEx::GetHelpContextID

  • Artículo

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

HRESULT GetHelpContextID(
   long * pulHelpID  // address of character's help topic ID
);

Recupera el helpContextID del carácter.

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

pulHelpID

Dirección de una variable que recibe el número de contexto del tema de ayuda para el carácter.

Si ha creado un archivo de Ayuda de Windows para la aplicación y ha establecido 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.

IAgentCharacterEx::GetHelpContextID devuelve el helpContextID que establece para el carácter. No devuelve el HelpContextID establecido por otros clientes.

Nota

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

 

Consulte también

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