Compartilhar via


Função GetNumberOfConsoleMouseButtons

Importante

Este documento descreve a funcionalidade da plataforma de console que não faz mais parte do nosso roteiro do ecossistema. Não recomendamos o uso desse conteúdo em novos produtos, mas continuaremos a oferecer suporte aos usos existentes por tempo indeterminado. Nossa solução moderna preferida se concentra em sequências de terminais virtuais para máxima compatibilidade em cenários de multiplataforma. Você pode encontrar mais informações sobre essa decisão de design em nosso documento Console clássico versus terminal virtual.

Recupera o número de botões no mouse usado pelo console atual.

Sintaxe

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

Parâmetros

lpNumberOfMouseButtons [out]
Um ponteiro para uma variável que recebe o número de botões do mouse.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Quando um console recebe alguma entrada do mouse, uma estrutura INPUT_RECORD contendo uma estrutura MOUSE_EVENT_RECORD é colocada no buffer de entrada do console. O membro dwButtonState de MOUSE_EVENT_RECORD apresenta um bit que indica o estado de cada botão do mouse. O bit será 1, se o botão estiver inoperante, e 0, se o botão estiver ativo. Para determinar o número de bits significativos, use GetNumberOfConsoleMouseButtons.

Dica

Essa API não é recomendada e não tem um terminal virtual equivalente. Essa decisão alinha propositalmente a plataforma Windows com outros sistemas operacionais. Esse estado é relevante somente para o contexto de usuário, sessão e privilégio locais. A comunicação remota de aplicativos por meio de utilitários multiplataforma e transportes como SSH pode não funcionar como esperado se essa API é usada.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho ConsoleApi3.h (via WinCon.h, inclui o Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções de Console

Buffer de entrada do console

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD