VBAで押されたキーボードを取得する方法【GetAsyncKeyState関数(API)】|CATIAマクロの作成方法

VBAマクロで押されたキーボードが何かを取得したい時があると思います。
恐らく、そう思う人の多くは最終的には「Aキーが押されたらこの処理をしたい」「スペースキーが押されたらあの処理をしたい」というように押されたキーが何なのかを取得して、取得したキーに対してそれぞれ処理を振り分けるというマクロを作りたいと考えていると思います。

VBAでのキーボード取得についていろいろ調べてみると、どうやらユーザーフォーム上で使用できるKeyDown/KeyUp(リンク先:Microsoftページ)というイベントがあるようですが、ここでやりたいのはユーザーフォームなどは何も使わずただ単に押されたキーを取得するというものです。

またExcelマクロだけでなくCATIAマクロでも利用可能なものにしたいと考えると、Windows APIを利用するというのが一番簡単かつ現実的な方法になってきます。(他にも方法があるかもしれませんが)

というわけで今回はWindows APIの押されているキーボードの状態を取得することのできる「GetAsyncKeyState」という関数を呼び出して、押されたキーボードをVBA上で取得する方法を解説していきます。

今回学ぶことのできる内容は以下のとおりです。

icon-check-square Windows APIについて
icon-check-square GetAsyncKeyState関数を使って押されたキーを取得する方法

このページではCATIAマクロでの実行を想定して解説しています。ただWindows APIを呼び出してVBAで使う方法はExcelマクロの場合も同じなので、Excelを使っている方の参考にもなると思います。

 

GetAsyncKeyState関数とは

GetAsyncKeyState関数とは関数を呼び出した時にキーが押されているかどうか、また前回のGetAsyncKeyState関数呼び出し以降にキーが押されたかどうかを判定することのできる関数です。

簡単にいえば任意のキーが現在押されているのか、
押されていないのかを確認することのできる関数ですね!

 

GetAsyncKeyState関数はVBAで用意されているものではなくWindows API(Application Programming Interface)の中にある関数です。Windows APIとは簡単にいえばWindowsに用意されている機能がまとまっているセットのようなものです。

Windows APIにはGetAsyncKeyState関数以外にも様々な関数があり、VBA上でそれらを呼び出すことで、Windowsに用意されている様々な機能を使用することができます。(たとえばWindowsのシステム効果音を鳴らしたり、指定した秒数だけ処理を止めることができます)

Windows APIをよく知らない方は「なんか難しそう」と感じると思いますがコードの内容はあまり難しいものではないので、VBAがある程度理解できている方であればすぐに理解することができます。

ちなみに名前からわかると思いますが、Windows APIではWindowsの機能を呼び出しているだけので基本的にはWindows以外のOSでは使用することはできません

 

GetAsyncKeyState関数の使い方

GetAsyncKeyState関数を使うには、マクロコードのはじめで「Windows APIのGetAsyncKeyState関数を使うよ」と宣言しておく必要があります。
※宣言をしないとGetAsyncKeyState関数は使えずエラーになるので書き忘れに注意しましょう。

宣言時に書く内容は使用しているWindowsが32bitか64bitかによって変わってきます。
以下のどちらかをコードの一番初め(Option Explicitの次の行あたり)に書いておくことで、そのモジュール内でGetAsyncKeyState関数を使うことができるようになります。

 icon-code 64bit 

Declare PtrSafe Function GetAsyncKeyState Lib “User32.dll” (ByVal vKey As Long) As Integer

 icon-code 32bit 

Declare Function GetAsyncKeyState Lib “User32.dll” (ByVal vKey As Long) As Integer

※大文字/小文字が違うだけでエラーが発生するので書き間違いに注意
 (VBAの構文と違い自動で大文字/小文字を変換してくれません)
 

上記のどちらのコードを書けばいいかわからない場合は、以下のコードをコピペしてモジュールの最上部(Option Explicitnの下)に書いておきましょう。

この構文を書いておくことで自動的に使うことのできる方の構文が使用されます。
VBE上では以下のように使えない方の構文が赤色で表示されますが、実行に影響はありません。

 

キー別の関数作成

GetAsyncKeyState関数の宣言が終わったら次に取得するキー別に関数を作成しておきます。
以下のコードを書くことで任意のキーが押されたいる場合にTrueを返すことができます。

icon-code キー別関数の作成

Function 関数名() As Boolean
 Const 定数名 = -32768
 関数名 = (GetAsyncKeyState(キーコード) And 定数名) = 定数名
End Function

関数名/定数名には好きな関数名/定数名を入力します。
キーコードには取得したいキーのキーコードを入力します。

各キーのキーコードは以下のPDFを参照ください。
GetAsyncKeyState関数-キーコード一覧(PDFファイル)』
このキーコード一覧の「vb○○」もしくは「数字」がキーコードとなります。

具体例をあげるとCtrlキーを取得したい場合は以下のようなコードで関数を作成します。
(「vbKeyControl」のかわりに「17」と入力しても実行可能)

このコードの場合、[Ctrl]キーが押されている時は「PressCtrl = True」[Ctrl]キーが押されていない場合は「PressCtrl = False」となります。つまりこの関数でキーが押されているか、押されていないのかを取得しています。

最終的にこの関数をメインのSubプロシージャ内で呼び出すことで、関数内で指定したキー(上記の場合[Ctrl]キー)が押された時に処理を行うという操作が可能になります。

ただ上記のコードの場合、[Ctrl]キー以外のキーを押してもそれらのキーを取得することはできません。そのため面倒ではありますが取得したいキーは全て、この方法で関数として作成しておく必要があります。(※すべてのキーを取得したい場合は、全てのキー分の関数を作成する必要があるということ)

ちなみにこのコードは以下のサイトを参考にしています。なぜ定数に「-32768」を入れているのかなども、わかりやすく解説されているので合わせて読んでみて下さい。

 

サンプルコード

実際に今までのコードをまとめたサンプルコードを見てみましょう。
以下のコードでは[Ctrl]キーの状態(キーが押されているか、押されていないか)を取得しています。

上記のコード(Sub CATMainの部分)を実行するとメッセージボックスが表示されます。

機能としてはこのメッセージボックスが表示されるときに[Ctrl]キーが押されている場合は「True」を、押されていない場合は「False」を表示するようになっています。
(マクロの処理速度は手動では追いつけないほどの速さなので、実際は[Ctrl]キーを押したまま実行しないと「True」と表示されないと思いますが)

 

ループを使って常に入力待ち状態にする

GetAsyncKeyState関数の使い方はわかりましたが、上記のサンプルコードのようにマクロ実行前にキーを押していないといけないというのは少し不便です。できることであれば、好きなタイミングでキーを押したとしてもそのキーを取得できるようにしたいです。

こういった場合はループ文とIf文を使えば再現することができます。
簡単にコードの内容をいうと、常に特に何も処理を行わないループ状態にしておき、キーが押された瞬間(つまりは作成した関数がTrueになった瞬間)に処理を行うという流れを組んでおけば、好きなタイミングでキーを押したとしてもそのキーを取得することができます。

文字だけだとわかりづらいので、実際に以下のコードを実行してみましょう。
実行後に各矢印キーを押してみて下さい。各キーに割り振られたメッセージが表示されます。
※マクロを終了するときは必ず[Esc]キーを押してください。

実際に実行するとわかるとおり矢印キーを押すたびに、「○矢印キーが押されました」とメッセージが表示されます。(Escキーが押されるまで何回も表示させることができます)

このシステムをうまく利用すれば好きなキーにさまざまな処理を割り振ることができます。

たとえば上記のコードの各キーの処理部分を「点座標の変更」の処理コードを書いておけば、矢印キーでゲームキャラクターのように点を操作する(動かす)ことも出来たりします。

 icon-warning 注意点 

このコードはキーを押さない限り処理を行わないとはいえ、裏で無限ループが常に行われている状態になってしまいます。これはあまりよろしいことではありませんが、どうしてもキー入力待ち状態がほしいという場合に1つの案として参考程度に使ってみて下さい。
またマクロ終了時に入力待ちループから抜け出すことも忘れないよう注意しておきましょう。

 

まとめ

今回はWindows APIのGetAsyncKeyState関数を使ったキーボードの取得についての内容でした。
キーボードを押したことにするVBAの「SendKeys」というものがありますが、Windows APIを使えばキーボードの押されたキーを取得するということも可能になります。

作業を効率化するマクロに対して、キーボードの入力(文字入力等の操作は除いて)が必要になる機会はほとんどないと思いますが、面白い機能だったので今回紹介させていただきました。

知識として入れておけばいつかは役に立つ時が来るかもしれません。
Windows APIでできる他の操作は「VBA API」で調べれば様々なサイトで解説しているのでそれらも参考にしてみるといいと思います。(ほとんどの場合Excel向けに解説していますが、APIの使い方はどれも共通なのでCATIAでも使えるはずです)
 

目次へ戻る
 

icon-book CATIAマクロを本気で勉強するなら

 

 

2020年7月1日CATIA, CATIAマクロ

Posted by Lic