Función WinHelpA (winuser.h)
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 WinHelpA(
HWND hWndMain,
LPCSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
Parámetros
hWndMain
Tipo: HWND
Identificador de la ventana que solicita ayuda. La función WinHelp 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 el control que solicita ayuda.
lpszHelp
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 WinHelp 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
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
Tipo: ULONG_PTR
Datos adicionales. El valor usado depende del valor del parámetro uCommand . Para obtener una lista de posibles valores dwData , vea la sección Comentarios.
Valor devuelto
Tipo: BOOL
Devuelve un valor distinto de cero si se ejecuta correctamente o cero en caso contrario. Para recuperar información de error extendida, llame a GetLastError.
Comentarios
Antes de cerrar la ventana que solicitó ayuda, la aplicación debe llamar a WinHelp con el parámetro uCommand establecido en HELP_QUIT. Hasta que todas las aplicaciones lo hayan hecho, la Ayuda de Windows no finalizará. Ten en cuenta que llamar a la Ayuda de Windows con el comando HELP_QUIT no es necesario si usaste el comando HELP_CONTEXTPOPUP para iniciar la Ayuda de Windows.
Esta función produce un error si se llama desde cualquier contexto, pero el usuario actual.
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 por compatibilidad con versiones anteriores. Las nuevas aplicaciones deben proporcionar un archivo .cnt y usar el comando HELP_FINDER. | Ignorado; establecido 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; establecido 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; establecido en 0. |
| HELP_HELPONHELP | Muestra ayuda sobre cómo usar la Ayuda de Windows, si el archivo Winhlp32.hlp está disponible. | Ignorado; establecido en 0. |
| HELP_INDEX | Muestra el tema especificado por la opción Contenido en la sección [OPTIONS] del archivo .hpj. Este comando es por compatibilidad con versiones anteriores. Las nuevas aplicaciones deben usar el comando HELP_FINDER. | Ignorado; establecido en 0. |
| HELP_KEY | Muestra el tema en 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 alternativa. | 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 en 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álogo Temas 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; establecido 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 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 especifique. | Dirección de una estructura 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 terminar con un par de ceros {0,0}. Si no desea agregar ayuda a un control determinado, establezca su identificador de contexto en -1. |
Nota
El encabezado winuser.h define WinHelp 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 |
|---|---|
| Cliente mínimo compatible | Windows XP [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows 2000 Server [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | winuser.h |
| Library | User32.lib |
| Archivo DLL | User32.dll |
| Conjunto de API | ext-ms-win-ntuser-misc-l1-5-1 (introducido en Windows 10, versión 10.0.14393) |