Función GetNumberOfConsoleMouseButtons

Importante

En este documento se describe funcionalidad de la plataforma de consola que ya no forma parte de nuestro plan de desarrollo del ecosistema. No se recomienda usar este contenido en nuevos productos, pero seguiremos admitiendo los usos existentes para el futuro indefinido. Nuestra solución moderna preferida se centra en secuencias de terminal virtual para lograr la máxima compatibilidad en escenarios multiplataforma. Puede encontrar más información sobre esta decisión de diseño en nuestro documento de Comparación de consola clásica y terminal virtual.

Recupera el número de botones del mouse que usa la consola actual.

Sintaxis

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

Parámetros

lpNumberOfMouseButtons [out]
Puntero a una variable que recibe el número de botones del mouse.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Cuando una consola recibe la entrada de mouse, se coloca en el búfer de entrada de la consola una estructura INPUT_RECORD que contiene otra estructura MOUSE_EVENT_RECORD. El miembro dwButtonState de MOUSE_EVENT_RECORD tiene un bit que indica el estado de cada botón del mouse. El bit es 1 si el botón está inactivo, y 0 si el botón está activo. Para determinar el número de bits significativos, utilice GetNumberOfConsoleMouseButtons.

Sugerencia

Esta API no se recomienda y no tiene un equivalente de terminal virtual. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos. Este estado solo es relevante para el contexto de los privilegios, la sesión y el usuario local. Es posible que las aplicaciones que se comunican remotamente a través de utilidades multiplataforma y los transportes como SSH no funcionen según lo previsto si se utiliza esta API.

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado ConsoleApi3.h (a través de WinCon.h, incluido Windows.h)
Biblioteca Kernel32.lib
Archivo DLL Kernel32.dll

Consulte también

Funciones de la consola

Búfer de entrada de la consola

PeekConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD