Partager via


Fonction GetNumberOfConsoleMouseButtons

Important

Ce document décrit les fonctionnalités de la plateforme de la console qui ne font plus partie de la feuille de route de notre écosystème. Nous vous déconseillons d’utiliser ce contenu dans de nouveaux produits, mais nous continuerons à prendre en charge des utilisations existantes pour l’avenir indéterminé. Notre solution moderne préférée se concentre sur les séquences de terminaux virtuels pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document sur les consoles classiques et les terminaux virtuels.

Récupère le nombre de boutons sur la souris utilisée par la console actuelle.

Syntaxe

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

Paramètres

lpNumberOfMouseButtons [sortie]
Un pointeur sur une variable qui reçoit le nombre de boutons de souris.

Valeur renvoyée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Notes

Lorsqu’une console reçoit une entrée de souris, une structure INPUT_RECORD contenant une structure MOUSE_EVENT_RECORD est placée dans la mémoire tampon d’entrée de la console. Le membre dwButtonState de la structure MOUSE_EVENT_RECORD contient un bit indiquant l'état de chaque bouton de souris. Le bit est 1 si le bouton est enfoncé et 0 si le bouton est relâché. Pour déterminer le nombre de bits significatifs, utilisez la fonction GetNumberOfConsoleMouseButtons.

Conseil

Cette API n’est pas recommandée et n’a pas d’équivalent de terminal virtuel. Cette décision aligne intentionnellement la plateforme Windows avec d’autres systèmes d’exploitation. Cet état n'est pertinent que pour l'utilisateur local, la session et le contexte des privilèges. La communication à distance des applications via des utilitaires multiplateformes et des transports comme SSH peut ne pas fonctionner comme prévu si vous utilisez cette API.

Spécifications

   
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
En-tête ConsoleApi3.h (via WinCon.h, include Windows.h)
Bibliothèque Kernel32.lib
DLL Kernel32.dll

Voir aussi

Fonctions de console

Mémoire tampon d’entrée d’une console

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD