Leer en inglés

Compartir a través de


Función MLHtmlHelp

[Esta función está disponible a través de Windows XP y Windows Server 2003. Es posible que se modifique o no esté disponible en versiones posteriores de Windows.

Muestra una ventana de ayuda que corresponde a la configuración actual del idioma de la interfaz de usuario.

Sintaxis

HWND MLHtmlHelp(
  _In_ HWND      hwndCaller,
  _In_ LPCTSTR   pszFile,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData,
  _In_ DWORD     dwCrossCodePage
);

Parámetros

hwndCaller [in]

Tipo: HWND

Identificador de la ventana primaria que llama a esta función.

pszFile [in]

Tipo: LPCTSTR

Puntero a un búfer que contiene la ruta de acceso completa de un archivo de ayuda compilada (.chm) o un archivo de tema dentro de un archivo de ayuda especificado.

uCommand [in]

Tipo: UINT

Comando que se va a completar. Esta función solo admite HH_DISPLAY_TOPIC y HH_DISPLAY_TEXT_POPUP. En el caso de cualquier otro comando, la llamada se reenvía sin el valor dwCrossCodePage a HtmlHelp.

dwData [in]

Tipo: DWORD_PTR

Cualquier dato que pueda ser necesario, en función del valor del parámetro uCommand .

dwCrossCodePage [in]

Tipo: DWORD

Valor DWORD que indica la página de códigos de la configuración actual del idioma de la interfaz de usuario, como CP_ACP.

Valor devuelto

Tipo: HWND

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

  • 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

Si surge un problema con la ruta de acceso del archivo de ayuda para el idioma actual, la llamada se reenvía a HtmlHelp para el control estándar.

Cuando se cierra la ventana de ayuda, el foco vuelve 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 MLHtmlHelp envía mensajes de notificación desde la ventana de ayuda, los mensajes 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.

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,
                     CP_ACP);

Nota

Al usar esta función, establezca el tamaño de pila del 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 se podría producir un error en la operación. Opcionalmente, puede quitar /STACK de la línea de comandos del vínculo y también 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 lo pasará al enlazador como /STACK).

 

Requisitos

Requisito Value
Cliente mínimo compatible
Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible
Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado
None
Archivo DLL
Shlwapi.dll (versión 5.0 o posterior)
Nombres Unicode y ANSI
MLHtmlHelpW (Unicode) y MLHtmlHelpA (ANSI)