Función HtmlHelpA (htmlhelp.h)

Muestra una ventana de ayuda.

Con los comandos de API, puede especificar qué tema mostrar en la ventana de ayuda, si la ventana de ayuda es un Visor de Ayuda de tres paneles o una ventana emergente, y si se debe tener acceso al archivo de tema HTML a través de un identificador de contexto, una dirección URL de ayuda HTML o una búsqueda de vínculo de palabra clave (KLink).

Sintaxis

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

Parámetros

[in, optional] hwndCaller

Especifica el identificador (hwnd) de la ventana que llama a HtmlHelp. La ventana de ayuda es propiedad de esta ventana.

Cuando se cierre la ventana de ayuda, HtmlHelp devolverá el foco al propietario a menos que el propietario sea el escritorio. Si hwndCaller es el escritorio, el sistema operativo determina dónde se devuelve el foco.

Además, si HtmlHelp envía mensajes de notificación desde la ventana de ayuda, se envían a hwndCaller siempre que haya habilitado el seguimiento de mensajes de notificación en la definición de la ventana de ayuda.

[in] pszFile

Según el valor uCommand , especifica la ruta de acceso del archivo a un archivo de ayuda compilado (.chm) o a un archivo de tema dentro de un archivo de ayuda especificado.

También se puede especificar un nombre de tipo de ventana , precedido de un carácter mayor que (>).

Si el comando especificado no requiere un archivo, este valor puede ser NULL.

[in] uCommand

Especifica el comando que se va a completar.

[in] dwData

Especifica los datos que pueden ser necesarios, en función del valor del parámetro uCommand .

Valor devuelto

Según el uCommand especificado y el resultado, HtmlHelp devuelve uno o ambos de los siguientes elementos:

• Identificador (hwnd) de la ventana de ayuda.
• NULL. En algunos casos, NULL indica un error; en otros casos, NULL indica que aún no se ha creado la ventana de ayuda.

Comentarios

La sintaxis se aplica a los juegos de caracteres ANSI. Cuando se usa un juego de caracteres Unicode, el tipo del parámetro pszFile debe ser "LPCTSTR".

Al usar la API de ayuda HTML, establezca el tamaño de pila del archivo ejecutable de hospedaje en al menos 100 000. Si el tamaño de pila definido es demasiado pequeño, el subproceso creado para ejecutar la Ayuda HTML también se creará con este tamaño de pila y podría producirse un error. Opcionalmente, puede quitar /STACK de la línea de comandos del vínculo y quitar cualquier configuración de STACK en el archivo DEF del ejecutable (el tamaño de pila predeterminado es de 1 MB en este caso). También puede establecer el tamaño de la pila mediante el comando del compilador /Fnumber (el compilador pasará esto al enlazador como /STACK).

Ejemplos

En el ejemplo siguiente se llama al comando HH_DISPLAY_TOPIC para abrir el archivo de ayuda denominado Help.chm y mostrar su tema predeterminado en la ventana de ayuda denominada Mainwin. Por lo general, la ventana de ayuda especificada en este comando es un Visor de Ayuda HTML estándar.

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

Nota

El encabezado htmlhelp.h define HtmlHelp como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	htmlhelp.h
Library	Htmlhelp.lib
Archivo DLL	hhctrl.ocx

Consulte también

Acerca de la API de ayuda HTML