IAgentCommandsEx::GetHelpContextID

[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 Commands object help topic ID
);

Recupera el HelpContextID de un objeto Command .

• 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 del objeto Command .

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 objeto Command . 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 objeto Command .

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::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::SetHelpFileName