在C#程序设计中使用Win32类库

时间：2011-02-25 来源：abstract未央

　　这就是我们要做的全部工作。下面是一个完整的示例，它生成的随机声音在二十世纪六十年代的科幻电影中很常见。

using System;
using System.Runtime.InteropServices;

namespace Beep
{
class Class1
　 {
　　　 [DllImport("kernel32.dll")]
　　　 public static extern bool Beep(int frequency, int duration);

　　　 static void Main(string[] args)
　　　 {
　　　　　 Random random = new Random();

　　　　　 for (int i = 0; i < 10000; i++)
　　　　　 {
　　　　　　 Beep(random.Next(10000), 100);
}
　　　 }
　 }
}
　　它的声响足以刺激任何听者！由于 DllImport 允许您调用 Win32 中的任何代码，因此就有可能调用恶意代码。所以您必须是完全受信任的用户，运行时才能进行 P/Invoke 调用。

　　枚举和常量

　　 Beep() 可用于发出任意声音，但有时我们希望发出特定类型的声音，因此我们改用 MessageBeep()。MSDN 给出了以下原型：

BOOL MessageBeep(
　 UINT uType // 声音类型
);
　　这看起来很简单，但是从注释中可以发现两个有趣的事实。

　　首先，uType 参数实际上接受一组预先定义的常量。

　　其次，可能的参数值包括 -1，这意味着尽管它被定义为 uint 类型，但 int 会更加适合。

　　对于 uType 参数，使用 enum 类型是合乎情理的。MSDN 列出了已命名的常量，但没有就具体值给出任何提示。由于这一点，我们需要查看实际的 API。

　　如果您安装了 Visual Studio? 和 C++，则 Platform SDK 位于 \Program Files\Microsoft Visual Studio .NET\Vc7\PlatformSDK\Include 下。

　　为查找这些常量，我在该目录中执行了一个 findstr。

　　 findstr "MB_ICONHAND" *.h

　　它确定了常量位于 winuser.h 中，然后我使用这些常量来创建我的 enum 和原型：

public enum BeepType
{
　 SimpleBeep = -1,
　 IconAsterisk = 0x00000040,
　 IconExclamation = 0x00000030,
　 IconHand = 0x00000010,
　 IconQuestion = 0x00000020,
　 Ok = 0x00000000,
}

[DllImport("user32.dll")]
public static extern bool MessageBeep(BeepType beepType);
　　现在我可以用下面的语句来调用它： MessageBeep(BeepType.IconQuestion);
处理结构

　　有时我需要确定我笔记本的电池状况。Win32 为此提供了电源管理函数。

　　搜索 MSDN 可以找到 GetSystemPowerStatus() 函数。

BOOL GetSystemPowerStatus(
　 LPSYSTEM_POWER_STATUS lpSystemPowerStatus
);
　　此函数包含指向某个结构的指针，我们尚未对此进行过处理。要处理结构，我们需要用 C# 定义结构。我们从非托管的定义开始：

typedef struct _SYSTEM_POWER_STATUS {
BYTE　 ACLineStatus;
BYTE　 BatteryFlag;
BYTE　 BatteryLifePercent;
BYTE　 Reserved1;
DWORD　BatteryLifeTime;
DWORD　BatteryFullLifeTime;
} SYSTEM_POWER_STATUS, *LPSYSTEM_POWER_STATUS;
　　然后，通过用 C# 类型代替 C 类型来得到 C# 版本。

struct SystemPowerStatus
{
　 byte ACLineStatus;
　 byte batteryFlag;
　 byte batteryLifePercent;
　 byte reserved1;
　 int batteryLifeTime;
　 int batteryFullLifeTime;
}
　　这样，就可以方便地编写出 C# 原型：

[DllImport("kernel32.dll")]
public static extern bool GetSystemPowerStatus(
　 ref SystemPowerStatus systemPowerStatus);
　　在此原型中，我们用“ref”指明将传递结构指针而不是结构值。这是处理通过指针传递的结构的一般方法。

　　此函数运行良好，但是最好将 ACLineStatus 和 batteryFlag 字段定义为 enum：

　　enum ACLineStatus: byte
　　 {
　　　 Offline = 0,
　　　 Online = 1,
　　　 Unknown = 255,
　　 }

　　 enum BatteryFlag: byte
　　 {
　　　 High = 1,
　　　 Low = 2,
　　　 Critical = 4,
　　　 Charging = 8,
　　　 NoSystemBattery = 128,
　　　 Unknown = 255,
　　 }
　　请注意，由于结构的字段是一些字节，因此我们使用 byte 作为该 enum 的基本类型。

　　根路径定义为 LPCTSTR。这是独立于平台的字符串指针。

　　由于不存在名为 GetDiskFreeSpace() 的函数，封送拆收器将自动查找“A”或“W”变体，并调用相应的函数。我们使用一个属性来告诉封送拆收器，API 所要求的字符串类型。

　　以下是该函数的完整定义，就象我开始定义的那样：

[DllImport("kernel32.dll")]
static extern bool GetDiskFreeSpace(
　 [MarshalAs(UnmanagedType.LPTStr)]
　 string rootPathName,
　 ref int sectorsPerCluster,
　 ref int bytesPerSector,
　 ref int numberOfFreeClusters,
　 ref int totalNumberOfClusters);
　　不幸的是，当我试图运行时，该函数不能执行。问题在于，无论我们在哪个平台上，封送拆收器在默认情况下都试图查找 API 的 Ansi 版本，由于 LPTStr 意味着在 Windows NT 平台上会使用 Unicode 字符串，因此试图用 Unicode 字符串来调用 Ansi 函数就会失败。

　　有两种方法可以解决这个问题：一种简单的方法是删除 MarshalAs 属性。如果这样做，将始终调用该函数的 A 版本，如果在您所涉及的所有平台上都有这种版本，这是个很好的方法。但是，这会降低代码的执行速度，因为封送拆收器要将 .NET 字符串从 Unicode 转换为多字节，然后调用函数的 A 版本（将字符串转换回 Unicode），最后调用函数的 W 版本。

　　要避免出现这种情况，您需要告诉封送拆收器，要它在 Win9x 平台上时查找 A 版本，而在 NT 平台上时查找 W 版本。要实现这一目的，可以将 CharSet 设置为 DllImport 属性的一部分：

[DllImport("kernel32.dll", CharSet = CharSet.Auto)] 　　
　　在我的非正式计时测试中，我发现这一做法比前一种方法快了大约百分之五。

　　对于大多数 Win32 API，都可以对字符串类型设置 CharSet 属性并使用 LPTStr。但是，还有一些不采用 A/W 机制的函数，对于这些函数必须采取不同的方法。

　　字符串缓冲区

　　 .NET 中的字符串类型是不可改变的类型，这意味着它的值将永远保持不变。对于要将字符串值复制到字符串缓冲区的函数，字符串将无效。这样做至少会破坏由封送拆收器在转换字符串时创建的临时缓冲区；严重时会破坏托管堆，而这通常会导致错误的发生。无论哪种情况都不可能获得正确的返回值。

　　要解决此问题，我们需要使用其他类型。StringBuilder 类型就是被设计为用作缓冲区的，我们将使用它来代替字符串。下面是一个示例：

[DllImport("kernel32.dll", CharSet = CharSet.Auto)]
public static extern int GetShortPathName(
　 [MarshalAs(UnmanagedType.LPTStr)]
　 string path,
　 [MarshalAs(UnmanagedType.LPTStr)]
　 StringBuilder shortPath,
　 int shortPathLength);
　　使用此函数很简单：

StringBuilder shortPath = new StringBuilder(80);
int result = GetShortPathName(@"d:\test.jpg", shortPath, shortPath.Capacity);
string s = shortPath.ToString();
　　请注意，StringBuilder 的 Capacity 传递的是缓冲区大小

　　 WCHAR　　　StandardName[ 32 ];
　　 SYSTEMTIME StandardDate;
　　 LONG　　　 StandardBias;
　　 WCHAR　　　DaylightName[ 32 ];
　　 SYSTEMTIME DaylightDate;
　　 LONG　　　 DaylightBias;
} TIME_ZONE_INFORMATION, *PTIME_ZONE_INFORMATION;
　　在 C# 中使用它需要有两种结构。一种是 SYSTEMTIME，它的设置很简单：

　 struct SystemTime
　 {
　　　 public short wYear;
　　　 public short wMonth;
　　　 public short wDayOfWeek;
　　　 public short wDay;
　　　 public short wHour;
　　　 public short wMinute;
　　　 public short wSecond;
　　　 public short wMilliseconds;
　 }
　　这里没有什么特别之处；另一种是 TimeZoneInformation，它的定义要复杂一些：

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
struct TimeZoneInformation
{
　 public int bias;
　 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
　 public string standardName;
　 SystemTime standardDate;
　 public int standardBias;
　 [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)]
　 public string daylightName;
　 SystemTime daylightDate;
　 public int daylightBias;
}
　　此定义有两个重要的细节。第一个是 MarshalAs 属性：

[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 32)] 　
　　查看 ByValTStr 的文档，我们发现该属性用于内嵌的字符数组；另一个是 SizeConst，它用于设置数组的大小。

　　我在第一次编写这段代码时，遇到了执行引擎错误。通常这意味着部分互操作覆盖了某些内存，表明结构的大小存在错误。我使用 Marshal.SizeOf() 来获取所使用的封送拆收器的大小，结果是 108 字节。我进一步进行了调查，很快回忆起用于互操作的默认字符类型是 Ansi 或单字节。而函数定义中的字符类型为 WCHAR，是双字节，因此导致了这一问题。

　　我通过添加 StructLayout 属性进行了更正。结构在默认情况下按顺序布局，这意味着所有字段都将以它们列出的顺序排列。CharSet 的值被设置为 Unicode，以便始终使用正确的字符类型。

　　经过这样处理后，该函数一切正常。您可能想知道我为什么不在此函数中使用 CharSet.Auto。这是因为，它也没有 A 和 W 变体，而始终使用 Unicode 字符串，因此我采用了上述方法编码。

　　具有回调的函数

　　当 Win32 函数需要返回多项数据时，通常都是通过回调机制来实现的。开发人员将函数指针传递给函数，然后针对每一项调用开发人员的函数。

　　在 C# 中没有函数指针，而是使用“委托”，在调用 Win32 函数时使用委托来代替函数指针。

　　 EnumDesktops() 函数就是这类函数的一个示例：

BOOL EnumDesktops(
　 HWINSTA hwinsta,　　　　　　 // 窗口实例的句柄
　 DESKTOPENUMPROC lpEnumFunc,　// 回调函数
　 LPARAM lParam　　　　　　　　// 用于回调函数的值
);
　　 HWINSTA 类型由 IntPtr 代替，而 LPARAM 由 int 代替。DESKTOPENUMPROC 所需的工作要多一些。下面是 MSDN 中的定义：

BOOL CALLBACK EnumDesktopProc(
　 LPTSTR lpszDesktop,　// 桌面名称
　 LPARAM lParam　　　　// 用户定义的值
);
　　我们可以将它转换为以下委托：

delegate bool EnumDesktopProc([MarshalAs(UnmanagedType.LPTStr)] string desktopName,int lParam);
　　完成该定义后，我们可以为 EnumDesktops() 编写以下定义：

[DllImport("user32.dll", CharSet = CharSet.Auto)]
static extern bool EnumDesktops(
　 IntPtr windowStation,
　 EnumDesktopProc callback,
　 int lParam);