IAgentCharacterEx::SetHelpFileName

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

HRESULT SetHelpFileName(
   BSTR bszName  // Help filename
);

Establece helpFileName para un carácter.

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

bszName

Nombre de archivo de la 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 Ayuda cuando HelpModeOn se establece en True y el usuario hace clic en el carácter o selecciona un comando en su menú emergente. 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::SetHelpContextID, IAgentCharacterEx::SetHelpModeOn, IAgentCharacterEx::GetHelpFileName