Leer en inglés

Compartir a través de


Función MLWinHelp

[Esta función está disponible a través de Windows XP y Windows Server 2003. Puede modificarse o no estar disponible en versiones posteriores de Windows.]

Inicia la Ayuda de Windows (Winhelp.exe) y pasa datos adicionales que indican la naturaleza de la ayuda solicitada por la aplicación.

Sintaxis

BOOL MLWinHelp(
  _In_ HWND      hWndMain,
  _In_ LPCTSTR   lpszHelp,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData
);

Parámetros

hWndMain [in]

Tipo: HWND

Identificador de la ventana que solicita ayuda. La función MLWinHelp usa este identificador para realizar un seguimiento de las aplicaciones que han solicitado ayuda. Si el parámetro uCommand especifica HELP_CONTEXTMENU o HELP_WM_HELP, hWndMain identifica la ayuda de solicitud de control.

lpszHelp [in]

Tipo: LPCTSTR

Dirección de una cadena terminada en NULL que contiene la ruta de acceso, si es necesario, y el nombre del archivo de ayuda que MLWinHelp va a mostrar.

El nombre de archivo puede ir seguido de un corchete angular (>) y el nombre de una ventana secundaria si el tema se va a mostrar en una ventana secundaria en lugar de en la ventana principal. Debe definir el nombre de la ventana secundaria en la sección [WINDOWS] del archivo del proyecto de ayuda (.hpj).

uCommand [in]

Tipo: UINT

Tipo de ayuda solicitado. Para obtener una lista de los valores posibles y cómo afectan al valor que se va a colocar en el parámetro dwData, vea la sección Comentarios.

dwData [in]

Tipo: DWORD_PTR

Datos adicionales. El valor utilizado depende del valor del parámetro uCommand. Para obtener una lista de los posibles valores de dwData vea la sección Comentarios.

Valor devuelto

Tipo: BOOL

Devuelve un valor distinto de cero si se ejecuta correctamente o cero de lo contrario. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Esta función no se incluye en un archivo de encabezado y debe llamarse mediante ordinal 395 para MLWinHelpA y 397 para MLWinHelpW.

MLWinHelp es esencialmente un contenedor para WinHelp. Intenta obtener la ruta de acceso al archivo de ayuda correspondiente a la configuración actual del idioma de la interfaz de usuario antes de llamar a WinHelp. Si se ejecuta correctamente, pasa esa ruta de acceso. Si se produce un error, pasa la ruta de acceso a la que apunta lpszHelp.

Esta función produce un error si se llama desde cualquier contexto, pero el usuario actual.

Antes de cerrar la ventana que solicitó ayuda, la aplicación debe llamar a MLWinHelp con el parámetro uCommand establecido en HELP_QUIT. Hasta que todas las aplicaciones lo hayan hecho, la Ayuda de Windows no finalizará. Tenga en cuenta que no es necesario llamar a la Ayuda de Windows con el comando HELP_QUIT si usó el comando HELP_CONTEXTPOPUP para iniciar la Ayuda de Windows.

En la tabla siguiente se muestran los valores posibles para el parámetro uCommand y los formatos correspondientes del parámetro dwData.

uCommand Acción dwData
HELP_COMMAND Ejecuta una macro de ayuda o una cadena de macro. Dirección de una cadena que especifica el nombre de las macros de ayuda que se van a ejecutar. Si la cadena especifica varios nombres de macro, los nombres deben estar separados por punto y coma. Debe usar la forma abreviada del nombre de la macro para algunas macros porque la Ayuda de Windows no admite el nombre largo.
HELP_CONTENTS Muestra el tema especificado por la opción Contenido en la sección [OPTIONS] del archivo .hpj. Este comando es para la compatibilidad con versiones anteriores. Las nuevas aplicaciones deben proporcionar un archivo .cnt y usar el comando HELP_FINDER. Ignorado; establézcalo en 0.
HELP_CONTEXT Muestra el tema identificado por el identificador de contexto especificado definido en la sección [MAP] del archivo .hpj. Contiene el identificador de contexto del tema.
HELP_CONTEXTMENU Muestra el menú Ayuda de la ventana seleccionada y, a continuación, muestra el tema del control seleccionado en una ventana emergente. Dirección de una matriz de pares DWORD. El primer DWORD de cada par es el identificador de control y el segundo es el identificador de contexto del tema. La matriz debe terminarse por un par de ceros {0,0}. Si no desea agregar ayuda a un control determinado, establezca su identificador de contexto en -1.
HELP_CONTEXTPOPUP Muestra el tema identificado por el identificador de contexto especificado definido en la sección [MAP] del archivo .hpj en una ventana emergente. Contiene el identificador de contexto de un tema.
HELP_FINDER Muestra el cuadro de diálogo Temas de ayuda. Ignorado; establézcalo en 0.
HELP_FORCEFILE Garantiza que la Ayuda de Windows muestre el archivo de ayuda correcto. Si se muestra el archivo de ayuda incorrecto, la Ayuda de Windows abre la correcta; de lo contrario, no hay ninguna acción. Ignorado; establézcalo en 0.
HELP_HELPONHELP Muestra ayuda sobre cómo usar la Ayuda de Windows, si el archivo Winhlp32.hlp está disponible. Ignorado; establézcalo en 0.
HELP_INDEX Muestra el tema especificado por la opción Contenido en la sección [OPTIONS] del archivo .hpj. Este comando es para la compatibilidad con versiones anteriores. Las nuevas aplicaciones deben usar el comando HELP_FINDER. Ignorado; establézcalo en 0.
HELP_KEY Muestra el tema de la tabla de palabras clave que coincide con la palabra clave especificada, si hay una coincidencia exacta. Si hay más de una coincidencia, muestra el índice con los temas enumerados en el cuadro de lista Temas encontrados. Dirección de una cadena de palabra clave. Varias palabras clave deben estar separadas por punto y coma.
HELP_MULTIKEY Muestra el tema especificado por una palabra clave en una tabla de palabras clave alternativas. Dirección de una estructura MULTIKEYHELP que especifica un carácter de nota al pie de tabla y una palabra clave.
HELP_PARTIALKEY Muestra el tema de la tabla de palabras clave que coincide con la palabra clave especificada, si hay una coincidencia exacta. Si hay más de una coincidencia, muestra el cuadro de diálogoTemas encontrados. Para mostrar el índice sin pasar una palabra clave, use un puntero a una cadena vacía. Dirección de una cadena de palabra clave. Varias palabras clave deben estar separadas por punto y coma.
HELP_QUIT Informa a la Ayuda de Windows de que ya no es necesario. Si ninguna otra aplicación ha solicitado ayuda, Windows cierra la Ayuda de Windows. Ignorado; establézcalo en 0.
HELP_SETCONTENTS Especifica el tema Contenido. La Ayuda de Windows muestra este tema cuando el usuario hace clic en el botón Contenido si el archivo de ayuda no tiene un archivo .cnt asociado. Contiene el identificador de contexto del tema Contenido.
HELP_SETPOPUP_POS Establece la posición de la ventana emergente posterior. Contiene los datos de posición. Use la macro MAKELONG para concatenar las coordenadas horizontales y verticales en un solo valor. La ventana emergente se coloca como si el cursor del mouse estuviera en el punto especificado cuando se invocó la ventana emergente.
HELP_SETWINPOS Muestra la ventana ayuda de Windows, si está minimizada o en memoria, y establece su tamaño y posición según se especifica. Dirección de una estructura de HELPWININFO que especifica el tamaño y la posición de una ventana de ayuda principal o secundaria.
HELP_TCARD Indica que un comando es para una instancia de tarjeta de entrenamiento de la Ayuda de Windows. Combine este comando con otros comandos mediante el operador OR bit a bit. Depende del comando con el que se combina este comando.
HELP_WM_HELP Muestra el tema del control identificado por el parámetro hWndMain en una ventana emergente. Dirección de una matriz de pares DWORD. El primer DWORD de cada par es un identificador de control y el segundo es un identificador de contexto para un tema. La matriz debe terminarse por un par de ceros {0,0}. Si no desea agregar ayuda a un control determinado, establezca su identificador de contexto en -1.

 

Requisitos

Requisito Valor
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
MLWinHelpW (Unicode) y MLWinHelpA (ANSI)

Consulte también

HELPWININFO

MULTIKEYHELP