GetNumberOfConsoleMouseButtons Funktion

  • Artikel

Wichtig

In diesem Dokument werden Konsolenplattformfunktionen beschrieben, die nicht mehr Teil unserer Ökosystem-Roadmap sind. Wir empfehlen nicht, diesen Inhalt in neuen Produkten zu verwenden, aber wir werden weiterhin vorhandene Nutzungen für die unbegrenzte Zukunft unterstützen. Unsere bevorzugte moderne Lösung konzentriert sich auf virtuelle Terminalsequenzen für maximale Kompatibilität in plattformübergreifenden Szenarien. Weitere Informationen zu dieser Designentscheidung finden Sie in unserem klassischen Konsolendokument im Vergleich zum virtuellen Terminal .

Ruft die Anzahl der Schaltflächen auf der Maus ab, die von der aktuellen Konsole verwendet wird.

Syntax

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

Parameter

lpNumberOfMouseButtons [out]
Ein Zeiger auf eine Variable, die die Anzahl der Maustasten empfängt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn eine Konsole Mauseingaben empfängt, wird eine INPUT_RECORD Struktur, die eine MOUSE_EVENT_RECORD Struktur enthält, im Eingabepuffer der Konsole platziert. Das dwButtonState-Element von MOUSE_EVENT_RECORD weist einen Bit auf den Zustand der einzelnen Maustasten hin. Das Bit ist 1, wenn die Schaltfläche nach unten und 0 ist, wenn die Schaltfläche nach oben ist. Verwenden Sie GetNumberOfConsoleMouseButtons, um die Anzahl der signifikanten Bits zu ermitteln.

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminalentsprechung. Diese Entscheidung richtet die Windows-Plattform absichtlich mit anderen Betriebssystemen aus. Dieser Zustand ist nur für den lokalen Benutzer-, Sitzungs- und Berechtigungskontext relevant. Anwendungen, die über plattformübergreifende Dienstprogramme und Transporte wie SSH remoten, funktionieren möglicherweise nicht wie erwartet, wenn Sie diese API verwenden.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Header ConsoleApi.h (über WinCon.h, Windows.h einschließen)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Konsolenfunktionen

Konsoleneingabepuffer

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD