演练:调用 Windows API (Visual Basic)

Windows API 是属于 Windows作系统的动态链接库(DLL)。 当难以编写自己的等效过程时,可以使用它们执行任务。 例如,Windows 提供了一个名为 FlashWindowEx 的函数,使应用程序标题栏在浅色和深色阴影之间交替。

在代码中使用 Windows API 的优势在于,它们可以节省开发时间,因为它们包含已编写并等待使用的数十个有用函数。 缺点是 Windows API 可能难以使用,在出现问题时难以恢复。

Windows API 表示特殊类别的互作性。 Windows API 不使用托管代码,没有内置类型库,并且使用的数据类型不同于与 Visual Studio 一起使用的数据类型。 由于这些差异,并且 Windows API 不是 COM 对象,因此使用平台调用或 PInvoke 实现与 Windows API 和 .NET Framework 的互操作性。 平台调用是一项服务,它使托管代码能够调用 DLL 中实现的非托管函数。 有关详细信息,请参阅 使用非托管 DLL 函数。 可以在 Visual Basic 中使用 PInvoke,方法是使用 Declare 语句或将 DllImport 属性应用于空过程。

Windows API 调用过去是 Visual Basic 编程的重要组成部分,但 Visual Basic .NET 很少是必需的。 尽可能使用 .NET Framework 中的托管代码来执行任务,而不是 Windows API 调用。 本指南提供了在必要时使用 Windows API 的情况信息。

注释

计算机可能会在以下说明中显示某些 Visual Studio 用户界面元素的不同名称或位置。 你拥有的 Visual Studio 版本以及所使用的设置决定了这些元素。 有关更多信息,请参阅 自定义 IDE

使用 Declare 的 API 调用

调用 Windows API 的最常见方法是使用 Declare 语句。

声明 DLL 过程

  1. 确定要调用的函数的名称,以及其参数、参数类型和返回值,以及包含它的 DLL 的名称和位置。

    注释

    有关 Windows API 的完整信息,请参阅平台 SDK Windows API 中的 Win32 SDK 文档。 有关 Windows API 使用的常量的详细信息,请检查平台 SDK 附带的标头文件,例如 Windows.h。

  2. 单击“文件”菜单上的“新建”,然后单击“项目”打开新的 Windows 应用程序项目。 将显示“新建项目”对话框。

  3. 从 Visual Basic 项目模板列表中选择 Windows 应用程序 。 将显示新项目。

  4. 将以下 Declare 函数添加到要使用的 DLL 的类或模块:

    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 系统目录中的文件的路径。

Alias如果调用的函数的名称不是有效的 Visual Basic 过程名称,或者与应用程序中其他项的名称冲突,请使用关键字。 Alias 指示要调用的函数的真实名称。

参数和数据类型声明

声明参数及其数据类型。 此部分可能具有挑战性,因为 Windows 使用的数据类型与 Visual Studio 数据类型不对应。 Visual Basic 通过将参数转换为兼容的数据类型(一种称为封送处理的过程)来完成大量工作。 可以显式控制参数的封送方式,方法是使用MarshalAsAttribute命名空间中定义的System.Runtime.InteropServices属性。

注释

以前版本的 Visual Basic 允许声明参数 As Any,这意味着可以使用任何数据类型的数据。 Visual Basic 要求对所有语句使用特定的数据类型 Declare

Windows API 常量

某些参数是常量的组合。 例如, MessageBox 本演练中显示的 API 接受一个名为控制 Typ 消息框显示方式的整数参数。 可以通过检查 #define 文件 WinUser.h 中的语句来确定这些常量的数字值。 数值通常以十六进制形式显示,因此你可能希望使用计算器来添加它们并转换为十进制值。 例如,如果要合并感叹号样式 MB_ICONEXCLAMATION 的常量0x00000030和“是/否”样式 MB_YESNO 0x00000004,则可以添加数字并获取0x00000034的结果或 52 个小数。 尽管可以直接使用小数结果,但最好将这些值声明为应用程序中的常量,并使用运算符将它们组合在 Or 一起。

声明 Windows API 调用的常量
  1. 请参阅要调用的 Windows 函数的文档。 确定它使用的常量的名称以及包含这些常量数值的 .h 文件的名称。

  2. 使用文本编辑器(如记事本)查看标头 (.h) 文件的内容,并查找与所使用的常量关联的值。 例如, MessageBox API 使用常量 MB_ICONQUESTION 在消息框中显示问号。 定义 MB_ICONQUESTION 在 WinUser.h 中,如下所示:

    #define MB_ICONQUESTION 0x00000020L

  3. 将等效 Const 语句添加到类或模块,使这些常量可供应用程序使用。 例如:

    Const MB_ICONQUESTION As Integer = &H20
    Const MB_YESNO As Integer = &H4
    Const IDYES As Integer = 6
    Const IDNO As Integer = 7
    
调用 DLL 过程
  1. 为项目添加一个名为 Button1 启动窗体的按钮,然后双击它以查看其代码。 按钮的事件处理程序显示出来。

  2. 将代码添加到 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
    
  3. 按 F5 运行项目。 消息框同时显示 “是 ”和 “否 ”响应按钮。 单击任一。

数据封送处理

Visual Basic 会自动转换 Windows API 调用的参数数据类型和返回值,但你可以使用 MarshalAs 该属性显式指定 API 所需的非托管数据类型。 有关互操作封送处理的详细信息,请参阅互操作封送处理

在 API 调用中使用 Declare 和 MarshalAs
  1. 确定要调用的函数的名称及其参数、数据类型和返回值。

  2. 若要简化对 MarshalAs 属性的访问,请将语句添加到 Imports 类或模块的代码顶部,如以下示例所示:

    Imports System.Runtime.InteropServices
    
  3. 将导入函数的函数原型添加到所使用的类或模块,并将 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 中的函数。 DllImport 与使用 Declare 语句大致等效,但可以更好地控制函数的调用方式。

只要调用是指向共享方法(有时称为DllImport方法),就可以在大多数 Windows API 调用中使用。 不能使用需要类的实例的方法。 与 Declare 语句不同,DllImport 调用不能使用 MarshalAs 特性。

使用 DllImport 属性调用 Windows API

  1. 单击“文件”菜单上的“新建”,然后单击“项目”打开新的 Windows 应用程序项目。 将显示“新建项目”对话框。

  2. 从 Visual Basic 项目模板列表中选择 Windows 应用程序 。 将显示新项目。

  3. 添加一个名为 Button2 启动窗体的按钮。

  4. 双击 Button2 以打开窗体的代码视图。

  5. 若要简化访问 DllImport,请在启动窗体类的代码顶部添加语句 Imports

    Imports System.Runtime.InteropServices
    
  6. 在窗体的 End Class 语句前面声明一个空函数,并命名该函数 MoveFile

  7. PublicShared 修饰符应用于函数声明,并根据 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 数据类型。

  8. DllImport 属性应用于空函数。 第一个参数是包含要调用的函数的 DLL 的名称和位置。 无需指定 Windows 系统目录中的文件的路径。 第二个参数是指定 Windows API 中函数的名称的命名参数。 在此示例中,该DllImport属性强制将对MoveFile的调用转发到KERNEL32.DLL中的MoveFileW。 该方法将文件从路径MoveFileW复制到路径src

    <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
    
  9. 将代码添加到 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
    
  10. 创建名为 Test.txt 的文件,并将其放置在硬盘驱动器上的 C:\Tmp 目录中。 如有必要,请创建 Tmp 目录。

  11. 按 F5 启动应用程序。 主窗体会出现。

  12. 单击 Button2。 如果文件可以移动,将显示消息“已成功移动文件”。

另请参阅