GetNumberOfConsoleMouseButtons

現在のコンソールが使用するマウスのボタン数を取得する。

GetNumberOfConsoleMouseButtons lpNumberOfMouseButtons

lpNumberOfMouseButtons : [var] マウスボタン数を受け取る変数へのポインタ。

(プラグイン / モジュール : kernel32.dll)

解説

現在のコンソールが使用するマウスのボタン数を取得する。

[戻り値]
関数が成功した場合、戻り値は 0 以外。関数が失敗した場合、戻り値は 0。拡張エラー情報を取得するには
[**GetLastError**](/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
を呼ぶ。

[備考]

コンソールがマウス入力を受信すると、[**MOUSE\_EVENT\_RECORD**](mouse-event-record-str.md)
構造体を含む [**INPUT\_RECORD**](input-record-str.md)
構造体がコンソールの入力バッファに置かれる。**MOUSE\_EVENT\_RECORD** の **dwButtonState**
メンバは、各マウスボタンの状態を示すビットを持つ。ボタンが押されている場合は 1、離されている場合は 0
となる。有効なビット数を判定するには **GetNumberOfConsoleMouseButtons** を使用する。> [!TIP]
> この API
は推奨されておらず、**[仮想ターミナル](console-virtual-terminal-sequences.md)**
に同等のものはない。この決定は意図的に Windows
プラットフォームを他のオペレーティングシステムと整合させるものである。この状態はローカルユーザー、セッション、特権コンテキストにのみ関係する。SSH
のようなクロスプラットフォームのユーティリティやトランスポート経由でリモート操作されるアプリケーションでは、この API
を使用すると期待通りに動作しない場合がある。

情報