チュートリアル: Windows API の呼び出し (Visual Basic)

[アーティクル]
05/10/2023

Windows API は、Windows オペレーティングシステムの一部であるダイナミックリンクライブラリ (DLL) です。独自の同等のプロシージャを記述することが困難な場合は、これらを使用してタスクを実行します。たとえば、Windows には FlashWindowEx という名前の関数が用意されていて、これを使用すると、アプリケーションのタイトルバーを交互に明るい色合いと暗い色合いにすることができます。

ご自身のコードで Windows API を使用する利点は、既に記述され、使用されるのを待っている便利な関数が多数含まれているため、開発時間を節約できることです。欠点として、Windows API は処理が容易でなく、問題が発生したときに困難な状況になることがあります。

Windows API は、相互運用性の特別なカテゴリを表しています。 Windows API にマネージドコードは使用されておらず、組み込みのタイプライブラリはありません。また、使用するデータ型は Visual Studio で使用するものとは異なります。これらの違いにより、また、Windows API は COM オブジェクトではないことから、Windows API および .NET Framework との相互運用性は、プラットフォーム呼び出し (PInvoke) を使用して実現されます。プラットフォーム呼び出しは、DLL に実装されたアンマネージド関数をマネージドコードから呼び出すことを可能にするサービスです。詳細については、「アンマネージド DLL 関数の処理」を参照してください。 Visual Basic で PInvoke を使用するには、Declare ステートメントを使用するか、DllImport 属性を空のプロシージャに適用します。

Windows API 呼び出しは、過去においては Visual Basic プログラミングの重要な部分でしたが、Visual Basic .NET ではほとんど必要ありません。可能な限り、Windows API 呼び出しではなく .NET Framework のマネージドコードを使用してタスクを実行するようにしてください。このチュートリアルでは、Windows API を使用することが必要な場合のために、情報を示します。

注意

次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「IDE をカスタマイズする」をご覧ください。

Declare を使用した API 呼び出し

Windows API を呼び出す最も一般的な方法は、Declare ステートメントを使用することです。

DLL プロシージャを宣言するには

呼び出す関数の名前と引数、引数の型、戻り値、さらに、その関数を含む DLL の名前と場所を特定します。

注意

Windows API の詳細については、プラットフォーム SDK Windows API の Win32 SDK ドキュメントを参照してください。 Windows API で使用する定数の詳細については、プラットフォーム SDK に付属している Windows.h などのヘッダーファイルを調べてください。
[ファイル] メニューの [新規作成] をクリックし、次に [プロジェクト] をクリックして、新しい Windows アプリケーションプロジェクトを開きます。 [新しいプロジェクト] ダイアログボックスが表示されます。
Visual Basic プロジェクトテンプレートの一覧から [Windows アプリケーション] を選択します。新しいプロジェクトが表示されます。

DLL を使用するクラスまたはモジュールに、次の Declare 関数を追加します。

Declare Auto Function MBox Lib "user32.dll" Alias "MessageBox" (
    ByVal hWnd As Integer,
    ByVal txt As String,
    ByVal caption As String,
    ByVal Typ As Integer) As Integer

Declare ステートメントの各部

Declare ステートメントには、次の要素が含まれます。

Auto 修飾子

Auto は、共通言語ランタイムの規則 (または、指定されている場合はエイリアス名) に従って、メソッド名に基づいて文字列を変換するようにランタイムに指示する修飾子です。

Lib キーワードと Alias キーワード

Function キーワードの後の名前は、インポートされた関数にアクセスするためにプログラムで使用する名前です。これは、呼び出す関数の実際の名前と同じにすることができます。または、任意の有効なプロシージャ名を使用し、Alias キーワードを使って呼び出す関数の実際の名前を指定することもできます。

Lib キーワードを指定し、その後に、呼び出す関数を含む DLL の名前と場所を指定します。 Windows システムディレクトリにあるファイルのパスを指定する必要はありません。

呼び出す関数の名前が有効な Visual Basic プロシージャ名ではない場合、またはアプリケーション内の他の項目の名前と競合する場合は、Alias キーワードを使用します。呼び出す関数の名前を Alias で示します。

引数とデータ型の宣言

引数とそのデータ型を宣言します。 Windows で使用されるデータ型は Visual Studio のデータ型に対応していないため、この部分は難しくなる可能性があります。 Visual Basic では、引数を互換性のあるデータ型に変換すること ("マーシャリング" と呼ばれるプロセス) によって、さまざまな処理が自動的に行われます。 System.Runtime.InteropServices 名前空間に定義されている MarshalAsAttribute 属性を使用して、引数のマーシャリング方法を明示的に制御できます。

注意

以前のバージョンの Visual Basic では、パラメーターを As Any と宣言することができました。これは、任意のデータ型のデータを使用できることを意味します。 Visual Basic では、すべての Declare ステートメントで特定のデータ型を使用する必要があります。

Windows API の定数

定数を組み合わせた引数もあります。たとえば、このチュートリアルに示されている MessageBox API では、メッセージボックスの表示方法を制御する Typ という整数の引数を使用できます。これらの定数の数値を確認するには、WinUser.h ファイルの #define ステートメントを調べます。通常、数値は 16 進数で表示されるので、加算や 10 進数への変換には電卓を使用した方がよいかもしれません。たとえば、感嘆符のスタイルを示す定数 MB_ICONEXCLAMATION 0x00000030 と、[はい] と [いいえ] のスタイルを示す定数 MB_YESNO 0x00000004 を組み合わせる場合は、これらの数値を加算して 0x00000034 または 10 進数の 52 という結果を得ることができます。 10 進数の結果を直接使用することもできますが、これらの値をアプリケーションで定数として宣言し、Or 演算子を使用して組み合わせることをお勧めします。

Windows API 呼び出しの定数を宣言するには

呼び出す Windows 関数のドキュメントを参照してください。使用する定数の名前と、定数の数値が含まれている .h ファイルの名前を確認します。
メモ帳などのテキストエディターを使用してヘッダー (.h) ファイルの内容を表示し、使用する定数に関連付けられている値を見つけます。たとえば、MessageBox API では、定数 MB_ICONQUESTION を使用して、メッセージボックスに疑問符を表示します。 MB_ICONQUESTION の定義は WinUser.h にあり、次のように表示されます。

#define MB_ICONQUESTION 0x00000020L
クラスまたはモジュールに同等の Const ステートメントを追加して、これらの定数をアプリケーションで使用できるようにします。次に例を示します。
```
Const MB_ICONQUESTION As Integer = &H20
Const MB_YESNO As Integer = &H4
Const IDYES As Integer = 6
Const IDNO As Integer = 7
```

DLL プロシージャを呼び出すには

Button1 という名前のボタンをプロジェクトのスタートアップフォームに追加し、それをダブルクリックしてコードを表示します。そのボタンに対応するイベントハンドラーが表示されます。

追加したボタンの Click イベントハンドラーにコードを追加して、プロシージャを呼び出し、適切な引数を指定します。

Private Sub Button1_Click(ByVal sender As System.Object,
    ByVal e As System.EventArgs) Handles Button1.Click

    ' Stores the return value.
    Dim RetVal As Integer
    RetVal = MBox(0, "Declare DLL Test", "Windows API MessageBox",
        MB_ICONQUESTION Or MB_YESNO)

    ' Check the return value.
    If RetVal = IDYES Then
        MsgBox("You chose Yes")
    Else
        MsgBox("You chose No")
    End If
End Sub

F5 キーを押して、プロジェクトを実行します。メッセージボックスに Yes と No の両方の応答ボタンが表示されます。どちらかをクリックします。

データマーシャリング

Visual Basic では、パラメーターと戻り値のデータ型が Windows API 呼び出し用に自動的に変換されますが、MarshalAs 属性を使用すると、API で想定されるアンマネージドデータ型を明示的に指定できます。相互運用マーシャリングの詳細については、「相互運用マーシャリング」を参照してください。

API 呼び出しで Declare と MarshalAs を使用するには

呼び出す関数の名前と引数、データ型、戻り値を特定します。
MarshalAs 属性へのアクセスを簡単にするために、次の例に示すように、クラスまたはモジュールのコードの先頭に Imports ステートメントを追加します。
```
Imports System.Runtime.InteropServices
```
使用するクラスまたはモジュールに、インポートされる関数の関数プロトタイプを追加し、MarshalAs 属性をパラメーターまたは戻り値に適用します。次の例では、型 void* が想定される API 呼び出しを AsAny としてマーシャリングしています。
```
Declare Sub SetData Lib "..\LIB\UnmgdLib.dll" (
    ByVal x As Short,
    <MarshalAsAttribute(UnmanagedType.AsAny)>
        ByVal o As Object)
```

DllImport を使用した API 呼び出し

DllImport 属性により、タイプライブラリを使用せずに DLL 内の関数を呼び出す第 2 の方法が提供されます。 DllImport は Declare ステートメントを使用するのとほぼ同等ですが、関数の呼び出し方法をより詳細に制御できます。

DllImport は、ほとんどの Windows API 呼び出しで使用できます。ただし、その呼び出しで共有 ("静的" とも呼ばれる) メソッドを参照している場合に限ります。クラスのインスタンスを必要とするメソッドは使用できません。 Declare ステートメントとは異なり、DllImport 呼び出しでは MarshalAs 属性を使用できません。

DllImport 属性を使用して Windows API を呼び出すには

[ファイル] メニューの [新規作成] をクリックし、次に [プロジェクト] をクリックして、新しい Windows アプリケーションプロジェクトを開きます。 [新しいプロジェクト] ダイアログボックスが表示されます。
Visual Basic プロジェクトテンプレートの一覧から [Windows アプリケーション] を選択します。新しいプロジェクトが表示されます。
Button2 という名前のボタンをスタートアップフォームに追加します。
Button2 をダブルクリックして、フォームのコードビューを開きます。
DllImport へのアクセスを簡単にするために、スタートアップフォームクラスのコードの先頭に Imports ステートメントを追加します。
```
Imports System.Runtime.InteropServices
```
フォームの End Class ステートメントの前に空の関数を宣言し、その関数に MoveFile という名前を指定します。
関数宣言に Public および Shared 修飾子を適用し、Windows API 関数で使用される引数に基づいて MoveFile のパラメーターを設定します。
```
Public Shared Function MoveFile(
    ByVal src As String,
    ByVal dst As String) As Boolean
    ' Leave the body of the function empty.
End Function
```
ご自身の関数には任意の有効なプロシージャ名を使用できます。DllImport 属性で、DLL 内の名前を指定します。また、それによってパラメーターと戻り値の相互運用マーシャリングも処理されるため、API で使用されているデータ型に似た Visual Studio データ型を選択できます。
空のクラスに DllImport 属性を適用します。最初のパラメーターは、呼び出す関数を含む DLL の名前と場所です。 Windows システムディレクトリにあるファイルのパスを指定する必要はありません。 2 番目のパラメーターは、Windows API 内の関数の名前を指定する名前付き引数です。この例では、DllImport 属性によって、MoveFile への呼び出しを KERNEL32.DLL 内の MoveFileW に強制的に転送しています。 MoveFileW メソッドにより、src パスから dst パスにファイルをコピーします。
```
<DllImport("KERNEL32.DLL", EntryPoint:="MoveFileW", SetLastError:=True,
    CharSet:=CharSet.Unicode, ExactSpelling:=True,
    CallingConvention:=CallingConvention.StdCall)>
Public Shared Function MoveFile(
    ByVal src As String,
    ByVal dst As String) As Boolean
    ' Leave the body of the function empty.
End Function
```

関数を呼び出すコードを Button2_Click イベントハンドラーに追加します。

Private Sub Button2_Click(ByVal sender As System.Object,
    ByVal e As System.EventArgs) Handles Button2.Click

    Dim RetVal As Boolean = MoveFile("c:\tmp\Test.txt", "c:\Test.txt")
    If RetVal = True Then
        MsgBox("The file was moved successfully.")
    Else
        MsgBox("The file could not be moved.")
    End If
End Sub

Test.txt という名前のファイルを作成し、ハードドライブの C:\Tmp ディレクトリに配置します。 Tmp ディレクトリは、必要に応じて作成してください。
F5 キーを押してアプリケーションを起動します。メインフォームが表示されます。
[Button2] をクリックします。ファイルを移動できた場合、"ファイルが正常に移動しました" というメッセージが表示されます。

チュートリアル: Windows API の呼び出し (Visual Basic)

Declare を使用した API 呼び出し

DLL プロシージャを宣言するには

Declare ステートメントの各部

Auto 修飾子

Lib キーワードと Alias キーワード

引数とデータ型の宣言

Windows API の定数

Windows API 呼び出しの定数を宣言するには

DLL プロシージャを呼び出すには

データマーシャリング

API 呼び出しで Declare と MarshalAs を使用するには

DllImport を使用した API 呼び出し

DllImport 属性を使用して Windows API を呼び出すには

関連項目

フィードバック

その他のリソース

チュートリアル: Windows API の呼び出し (Visual Basic)

Declare を使用した API 呼び出し

DLL プロシージャを宣言するには

Declare ステートメントの各部

Auto 修飾子

Lib キーワードと Alias キーワード

引数とデータ型の宣言

Windows API の定数

Windows API 呼び出しの定数を宣言するには

DLL プロシージャを呼び出すには

データ マーシャリング

API 呼び出しで Declare と MarshalAs を使用するには

DllImport を使用した API 呼び出し

DllImport 属性を使用して Windows API を呼び出すには

関連項目

フィードバック

その他のリソース

データマーシャリング