GetNumberOfConsoleMouseButtons 関数

重要

このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。

現在のコンソールで使用されているマウス上のボタンの数を取得します。

構文

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

パラメーター

lpNumberOfMouseButtons [out]
マウス ボタンの数を受信する変数へのポインター。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

コンソールがマウス入力を受信すると、MOUSE_EVENT_RECORD 構造体を含む INPUT_RECORD 構造体がコンソールの入力バッファーに配置されます。 MOUSE_EVENT_RECORD の dwButtonState メンバーには、各マウス ボタンの状態を示すビットがあります。 ボタンが下にある場合はビットは 1、ボタンが上にある場合は 0 です。 重要なビット数を確認するには、GetNumberOfConsoleMouseButtons を使用します。

ヒント

この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定は、Windows プラットフォームを他のオペレーティング システムと意図的に調整します。 この状態は、ローカル ユーザー、セッション、および権限コンテキストにのみ関連します。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー	ConsoleApi3.h（WinCon.h 経由、Windows.h を含む）
ライブラリ	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

コンソール関数

コンソールの入力バッファー

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD