Функция GetNumberOfConsoleMouseButtons

Статья
10/23/2023

Важно!

В этом документе описаны функции платформы консоли, которые больше не являются частью стратегии развития экосистемы. Мы не рекомендуем использовать это содержимое в новых продуктах, но мы будем продолжать поддерживать существующие использования для неопределенного будущего. Наше предпочтительное современное решение ориентировано на последовательности виртуальных терминалов для обеспечения максимальной совместимости в кроссплатформенных сценариях. Дополнительные сведения об этом решении по проектированию можно найти в классической консоли и в документе виртуального терминала .

Извлекает количество кнопок мыши, используемых текущей консолью.

Синтаксис

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

Параметры

lpNumberOfMouseButtons [out]
Указатель на переменную, которая получает количество кнопок мыши.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Замечания

Когда консоль получает входные данные мыши, INPUT_RECORD структура, содержащая структуру MOUSE_EVENT_RECORD, помещается в входной буфер консоли. Элемент dwButtonState MOUSE_EVENT_RECORD имеет бит, указывающий состояние каждой кнопки мыши. Бит равен 1, если кнопка вниз и 0, если кнопка находится вверх. Чтобы определить количество битов, которые являются значительными, используйте GetNumberOfConsoleMouseButtons.

Совет

Этот API не рекомендуется и не имеет эквивалента виртуального терминала . Это решение намеренно сопоставляет платформу Windows с другими операционными системами. Это состояние относится только к локальному пользователю, сеансу и контексту привилегий. Удаленное взаимодействие приложений с помощью межплатформенных служебных программ и транспорта, таких как SSH, может не работать должным образом, если используется этот API.

Requirements


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Верхний колонтитул	ConsoleApi3.h (через WinCon.h, включая Windows.h)
Библиотека	Kernel32.lib
DLL-библиотеки	Kernel32.dll