[轉]C# 互通性入門系列(三)：平台叫用中的資料封送處理

標籤：

傳送門

C#互操作系列文章：

1. C#互通性入門系列(一)：C#中互通性介紹
2. C#互通性入門系列(二)：使用平台叫用調用Win32 函數
3. C#互通性入門系列(三)：平台叫用中的資料封送處理
4. C#互通性入門系列(四)：在C# 中調用COM組件

本專題概要

• 資料封送介紹
• 封送Win32資料類型
• 封送字串的處理
• 封送結構體的處理
• 封送類的處理
• 小結

一、資料封送介紹

看到這個專題時，大家的第一個疑問肯定是——什麼是資料封送呢？(這系列專題中採用假設朋友的提問方式來解說概念，就是希望大家帶著問題去學習本專題內容，以及大家在平時的學習過程中也可以採用這個方式，個人覺得這個方式可以使自己學習效率有所提高，即使這樣在學習的過程可能會顯得慢了，但是這種方式會對你所看過的知識點會有一個更深的印象。遠比看的很快，最後卻發現記住的沒多少強，在這裡分享下這個學習方式，認為可以接受的朋友可以在平時的學習中可以嘗試下的，如果覺得不好的話，相信大家肯定也會有自己更好的學習方式的。)對於這個問題的解釋是，資料封送是——在Managed 程式碼中對非託管函數進行互操作時，需要通過方法的參數和傳回值在託管記憶體和非託管記憶體之間傳遞資料的過程，資料封送處理的過程是由CLR(通用語言執行平台)的封送處理服務(即封送拆送器)完成的。

封送拆送器主要進行3項任務：

1. 將資料從託管類型轉換為非託管類型，或從非託管類型轉換為託管類型
2. 將經過類型轉換的資料從Managed 程式碼記憶體複製到非託管記憶體，或從非託管記憶體複製到託管記憶體
3. 調用完成後，釋放封送處理過程中分配的記憶體

二、封送Win32資料類型

對Unmanaged 程式碼進行互操作時，一定會有資料的封送處理。然而封送時需要處理的資料類型分為兩種——可直接複製到本機結構中的類型(blittable)和非直接複製到本機結構中的類型(non-bittable)。下面就這兩種資料類型分別做一個介紹。

2.1 可直接複製到本機結構中的類型

由於在Managed 程式碼和Unmanaged 程式碼中，資料類型在託管記憶體和非託管記憶體的表示形式不一樣，因為這樣的原因，所以我們需要對資料進行封送處理，以至於在Managed 程式碼中調用非託管函數時，把正確的傳入參數傳遞給非託管函數和把正確的傳回值返回給Managed 程式碼中。然而，並不是所有資料類型在兩者記憶體的表現形式不一樣的，這時候我們把在託管記憶體和非託管記憶體中有相同表現形式的資料類型稱為——可直接複製到本機結構中的類型，這些資料類型不需要封送拆送器進行任何特殊的處理就可以在託管和Unmanaged 程式碼之間傳遞, 下面列出一些課直接複製到本機結構中的單一資料型別：

Windows 資料類型

非管理的資料類型

管理的資料類型

管理的資料類型解釋

BYTE/Uchar/UInt8

unsigned char

System.Byte

無符號8位整型

Sbyte/Char/Int8

char

System.SByte

有符號8位整型

Short/Int16

short

System.Int16

有符號16位整型

USHORT/WORD/UInt16/WCHAR

unsigned short

System.UInt16

無符號16位整型

Bool/HResult/Int/Long

long/int

System.Int32

有符號32位整型

DWORD/ULONG/UINT

unsigned long/unsigned int

System.UInt32

無符號32位整型

INT64/LONGLONG

_int64

System.Int64

有符號64位整型

UINT64/DWORDLONG/ULONGLONG

_uint64

System.UInt64

無符號64位整型

INT_PTR/hANDLE/wPARAM

void*/int或_int64

System.IntPtr

有符號指標類型

HANDLE

void*

System.UIntPtr

無符號指標類型

FLOAT

float

System.Single

單精確度浮點數

DOUBLE

double

System.Double

雙精確度浮點數

除了上表列出來的簡單類型之外，還有一些複製類型也屬於可直接複製到本機結構中的資料類型：

（1） 資料元素都是可直接複製到本機結構中的一元數組，如整數數組，浮點數組等

（2）只包含可直接複製到本機結構中的格式化實值型別

（3）成員變數全部都是可複製到本機結構中的類型且作為格式化類型封送的類

上面提到的格式化指的是——在類型定義時，成員的記憶體布局在聲明時就明確指定的類型。在代碼中用StructLayout屬性修飾被指定的類型，並將StructLayout的LayoutKind屬性設定為Sequential或Explicit，例如：

using System.Runtime.InteropServices;// 下面的結構體也屬於可直接複製到本機結構中的類型[StructLayout(LayoutKind.Sequential)]public struct Point {   public int x;   public int y;}   

2.2 非直接複製到本機結構中的類型

如果一個類型不是可直接複製到本機結構中的類型，那麼它就是非直接複製到本機結構中的類型。由於一些類型在託管記憶體和非託管記憶體的表現形式不一樣，所以對於這種類型，封送器需要對它們進行相應的類型轉換之後再複製到被調用的函數中，下面列出一些非直接複製到本機結構中的資料類型：

Windows 資料類型

非管理的資料類型

管理的資料類型

管理的資料類型解釋

Bool

bool

System.Boolean

布爾類型

WCHAR/TCHAR

char/ wchar_t

System.Char

ANSI字元/Unicode字元

LPCSTR/LPCWSTR/LPCTSTR/LPSTR/LPWSTR/LPTSTR

const char*/const wchar_t*/char*/wchar_t*

System.String

ANSI字串/Unicode字串，如果Unmanaged 程式碼不需要更新此字串時，此時用String類型在Managed 程式碼中聲明字串類型

LPSTR/LPWSTR/LPTSTR

Char*/wchar_t*

System.StringBuilder

ANSI字串/Unicode字串，如果Unmanaged 程式碼需要更新此字串，然後把更新的字串傳回Managed 程式碼中，此時用StringBuilder類型在Managed 程式碼中聲明字串

除了上表中列出的類型之外，還有很多其他類型屬於非直接複製到本機結構中的類型，例如其他指標類型和控制代碼類型等。理解了blittable和non-blittable類型的區別之後，就可以在互操作過程更好地處理資料的封送，下面就具體的一些資料類型的封送問題做一個簡單介紹

三、封送字串的處理

在上一個專題中，我們已經涉及到字串的封送問題了(上一個專題中使用了將字串作為In參數傳遞給Win32 MessageBox 函數，具體可以查看上一個專題) 。所以在這部分將介紹——封送作為傳回值的字串,下面是一段示範代碼,代碼中主要是調用Win32 GetTempPath函數來獲得返回返回臨時路徑,此時拆送器就需要把返回的字串封送回Managed 程式碼中。

// 託管函數中的傳回值封送回託管函數的例子    class Program    {        // Win32 GetTempPath函數的定義如下：   //DWORD WINAPI GetTempPath(//  _In_   DWORD nBufferLength,//  _Out_  LPTSTR lpBuffer//);    // 主要是注意如何在Managed 程式碼中定義該函數原型       
        [DllImport("Kernel32.dll", CharSet = CharSet.Unicode, SetLastError=true)]        public static extern uint GetTempPath(int bufferLength, StringBuilder buffer);        static void Main(string[] args)        {            StringBuilder buffer = new StringBuilder(300);            uint tempPath=GetTempPath(300, buffer);            string path = buffer.ToString();            if (tempPath == 0)            {                int errorcode =Marshal.GetLastWin32Error();                Win32Exception win32expection = new Win32Exception(errorcode);                Console.WriteLine("調用非託管函數發生異常，異常資訊為：" +win32expection.Message);            }            Console.WriteLine("調用非託管函數成功。");            Console.WriteLine("Temp 路徑為：" + buffer);             Console.Read();        }    }

運行結果為:

四、封送結構體的處理

在我們實際調用Win32 API函數時，經常需要封送結構體和類等複製類型，下面就以Win32 函數GetVersionEx為例子來示範如何對作為參數的結構體進行封送處理。為了在Managed 程式碼中調用Unmanaged 程式碼,首先我們就要知道非託管函數的定義,下面是GetVersionEx非託管定義(更多關於該函數的資訊可以參看MSDN連結:http://msdn.microsoft.com/en-us/library/ms885648.aspx )：

BOOL GetVersionEx(   LPOSVERSIONINFO lpVersionInformation); 

參數lpVersionInformation是一個指向 OSVERSIONINFO結構體的指標類型,所以我們在Managed 程式碼中為函數GetVersionEx函數之前，必須知道 OSVERSIONINFO結構體的非託管定義，然後再在Managed 程式碼中定義一個等價的結構體類型作為參數。以下是OSVERSIONINFO結構體的非託管定義：

typedef struct  _OSVERSIONINFO{    DWORD dwOSVersionInfoSize;       //在使用GetVersionEx之前要將此初始化為結構的大小    DWORD dwMajorVersion;               //系統主要版本號    DWORD dwMinorVersion;               //系統次版本號碼    DWORD dwBuildNumber;               //系統構建號    DWORD dwPlatformId;                  //系統支援的平台    TCHAR szCSDVersion[128];          //系統補丁包的名稱    WORD wServicePackMajor;            //系統補丁包的主要版本    WORD wServicePackMinor;            //系統補丁包的次版本    WORD wSuiteMask;                      //標識系統上的程式組    BYTE wProductType;                    //標識系統類別型    BYTE wReserved;                         //保留,未使用} OSVERSIONINFO;

知道了OSVERSIONINFO結構體在Unmanaged 程式碼中的定義之後, 現在我們就需要在Managed 程式碼中定義一個等價的結構，並且要保證兩個結構體在記憶體中的布局相同。Managed 程式碼中的結構體定義如下：

  // 因為Win32 GetVersionEx函數參數lpVersionInformation是一個指向 OSVERSIONINFO的資料結構        // 所以Managed 程式碼中定義個結構體，把結構體對象作為非託管函數參數        [StructLayout(LayoutKind.Sequential,CharSet=CharSet.Unicode)]        public struct OSVersionInfo        {            public UInt32 OSVersionInfoSize; // 結構的大小，在調用方法前要初始化該欄位            public UInt32 MajorVersion; // 系統主要版本號            public UInt32 MinorVersion; // 系統此版本號碼            public UInt32 BuildNumber;  // 系統構建號            public UInt32 PlatformId;  // 系統支援的平台            // 此屬性用於表示將其封送成內聯數組            [MarshalAs(UnmanagedType.ByValTStr,SizeConst=128)]            public string CSDVersion; // 系統補丁包的名稱            public UInt16 ServicePackMajor; // 系統補丁包的主要版本            public UInt16 ServicePackMinor;  // 系統補丁包的次版本            public UInt16 SuiteMask;   //標識系統上的程式組            public Byte ProductType;    //標識系統類別型            public Byte Reserved;  //保留,未使用        }

從上面的定義可以看出, Managed 程式碼中定義的結構體有以下三個方面與Unmanaged 程式碼中的結構體是相同的:

• 欄位聲明的順序
• 欄位的類型
• 欄位在記憶體中的大小

並且在上面結構體的定義中,我們使用到了 StructLayout 屬性，該屬性屬於System.Runtime.InteropServices命名空間(所以在使用平台叫用技術必須添加這個額外的命名空間)。這個類的作用就是允許開發人員顯式指定結構體或類中資料欄位的記憶體布局,為了保證結構體中的資料欄位在記憶體中的順序與定義時一致,所以指定為 LayoutKind.Sequential（該枚舉也是預設值)。 下面就具體看看在Managed 程式碼中調用的代碼：

using System;using System.ComponentModel;using System.Runtime.InteropServices;namespace 封送結構體的處理{    class Program    {        // 對GetVersionEx進行託管定義        // 為了傳遞指向結構體的指標並將初始化的資訊傳遞給Unmanaged 程式碼，需要用ref關鍵字修飾參數
        // 這裡不能使用out關鍵字，如果使用了out關鍵字，CLR就不會對參數進行初始化操作，這樣就會導致調用失敗
        [DllImport("Kernel32",CharSet=CharSet.Unicode,EntryPoint="GetVersionEx")]        private static extern Boolean GetVersionEx_Struct(ref  OSVersionInfo osVersionInfo);        // 因為Win32 GetVersionEx函數參數lpVersionInformation是一個指向 OSVERSIONINFO的資料結構        // 所以Managed 程式碼中定義個結構體，把結構體對象作為非託管函數參數        [StructLayout(LayoutKind.Sequential,CharSet=CharSet.Unicode)]        public struct OSVersionInfo        {            public UInt32 OSVersionInfoSize; // 結構的大小，在調用方法前要初始化該欄位            public UInt32 MajorVersion; // 系統主要版本號            public UInt32 MinorVersion; // 系統此版本號碼            public UInt32 BuildNumber;  // 系統構建號            public UInt32 PlatformId;  // 系統支援的平台            // 此屬性用於表示將其封送成內聯數組            [MarshalAs(UnmanagedType.ByValTStr,SizeConst=128)]            public string CSDVersion; // 系統補丁包的名稱            public UInt16 ServicePackMajor; // 系統補丁包的主要版本            public UInt16 ServicePackMinor;  // 系統補丁包的次版本            public UInt16 SuiteMask;   //標識系統上的程式組            public Byte ProductType;    //標識系統類別型            public Byte Reserved;  //保留,未使用        }        // 獲得作業系統資訊        private static string GetOSVersion()        {            // 定義一個字串儲存版本資訊            string versionName = string.Empty;            // 初始化一個結構體對象            OSVersionInfo osVersionInformation = new OSVersionInfo();            // 調用GetVersionEx 方法前，必須用SizeOf方法設定結構體中OSVersionInfoSize 成員            osVersionInformation.OSVersionInfoSize = (UInt32)Marshal.SizeOf(typeof(OSVersionInfo));            // 調用Win32函數            Boolean result = GetVersionEx_Struct(ref osVersionInformation);            if (!result)            {                // 如果調用失敗，獲得最後的錯誤碼                int errorcode = Marshal.GetLastWin32Error();                Win32Exception win32Exc = new Win32Exception(errorcode);                Console.WriteLine("調用失敗的錯誤資訊為： " + win32Exc.Message);                // 調用失敗時返回為空白字串                return string.Empty;            }            else            {                Console.WriteLine("調用成功");                switch (osVersionInformation.MajorVersion)                {                    // 這裡僅僅討論 主要版本號為6的情況，其他情況是一樣討論的                    case 6:                        switch (osVersionInformation.MinorVersion)                        {                            case 0:                                if (osVersionInformation.ProductType == (Byte)0)                                {                                    versionName = " Microsoft Windows Vista";                                }                                else                                {                                    versionName = "Microsoft Windows Server 2008"; // 伺服器版本                                }                                break;                            case 1:                                if (osVersionInformation.ProductType == (Byte)0)                                {                                    versionName = " Microsoft Windows 7";                                }                                else                                {                                    versionName = "Microsoft Windows Server 2008 R2";                                }                                break;                            case 2:                                versionName = "Microsoft Windows 8";                                break;                        }                        break;                    default:                        versionName = "未知的作業系統";                        break;                }                return versionName;            }        }        static void Main(string[] args)        {            string OS=GetOSVersion();            Console.WriteLine("當前電腦安裝的作業系統為：{0}", OS);            Console.Read();        }    }}

運行結果為:

附上微軟作業系統名和版本號碼的對應關係,大家可以參考下面的表對上面代碼進行其他的討論:

作業系統

版本號碼

Windows 8

6.2

Windows 7

6.1

Windows Server   2008 R2

6.1

Windows Server   2008

6.0

Windows Vista

6.0

Windows Server   2003 R2

5.2

Windows Server   2003

5.2

Windows XP

5.1

Windows 2000

5.0

五、封送類的處理

下面直接通過GetVersionEx函數進行封送類的處理的例子，具體代碼如下：

using System;using System.ComponentModel;using System.Runtime.InteropServices;namespace 封送類的處理{    class Program    {        // 對GetVersionEx進行託管定義        // 由於類的定義中CSDVersion為String類型，String是非直接複製到本機結構類型，        // 所以封送拆送器需要進行複製操作。        // 為了是Unmanaged 程式碼能夠獲得在Managed 程式碼中對象設定的初始值(指的是OSVersionInfoSize欄位，調用函數前首先初始化該值),        // 所以必須加上[In]屬性；函數返回時，為了將結果複製到託管對象中，必須同時加上 [Out]屬性        // 這裡不能是用ref關鍵字，因為 OsVersionInfo是類類型，本來就是參考型別，如果加ref 關鍵字就是傳入的為指標的指標了，這樣就會導致調用失敗
        [DllImport("Kernel32", CharSet = CharSet.Unicode, EntryPoint = "GetVersionEx")]        private static extern Boolean GetVersionEx_Struct([In, Out]  OSVersionInfo osVersionInfo);        // 獲得作業系統資訊        private static string GetOSVersion()        {            // 定義一個字串儲存作業系統資訊            string versionName = string.Empty;            // 初始化一個類對象            OSVersionInfo osVersionInformation = new OSVersionInfo();            // 調用Win32函數            Boolean result = GetVersionEx_Struct(osVersionInformation);            if (!result)            {                // 如果調用失敗，獲得最後的錯誤碼                int errorcode = Marshal.GetLastWin32Error();                Win32Exception win32Exc = new Win32Exception(errorcode);                Console.WriteLine("調用失敗的錯誤資訊為： " + win32Exc.Message);                // 調用失敗時返回為空白字串                return string.Empty;            }            else            {                Console.WriteLine("調用成功");                switch (osVersionInformation.MajorVersion)                {                    // 這裡僅僅討論 主要版本號為6的情況，其他情況是一樣討論的                    case 6:                        switch (osVersionInformation.MinorVersion)                        {                            case 0:                                if (osVersionInformation.ProductType == (Byte)0)                                {                                    versionName = " Microsoft Windows Vista";                                }                                else                                {                                    versionName = "Microsoft Windows Server 2008"; // 伺服器版本                                }                                break;                            case 1:                                if (osVersionInformation.ProductType == (Byte)0)                                {                                    versionName = " Microsoft Windows 7";                                }                                else                                {                                    versionName = "Microsoft Windows Server 2008 R2";                                }                                break;                            case 2:                                versionName = "Microsoft Windows 8";                                break;                        }                        break;                    default:                        versionName = "未知的作業系統";                        break;                }                return versionName;            }        }        static void Main(string[] args)        {            string OS = GetOSVersion();            Console.WriteLine("當前電腦安裝的作業系統為：{0}", OS);            Console.Read();        }    }    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]    public class OSVersionInfo    {        public UInt32 OSVersionInfoSize = (UInt32)Marshal.SizeOf(typeof(OSVersionInfo));        public UInt32 MajorVersion = 0;        public UInt32 MinorVersion = 0;        public UInt32 BuildNumber = 0;        public UInt32 PlatformId = 0;        // 此屬性用於表示將其封送成內聯數組        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]        public string CSDVersion = null;        public UInt16 ServicePackMajor = 0;        public UInt16 ServicePackMinor = 0;        public UInt16 SuiteMask = 0;        public Byte ProductType = 0;        public Byte Reserved;    }}

運行結果還是和上面使用結構體定義的一樣,還是附上吧:

六、小結

本專題主要介紹了幾種類型的資料封送處理, 對於封送處理的一句話概括就是——保證Managed 程式碼中定義的資料在記憶體中的布局與Unmanaged 程式碼中的記憶體布局相同，專題中也列出了一些簡單類型在Unmanaged 程式碼和Managed 程式碼中定義的對應關係，對於一些沒有列出來的指標類型或回呼函數等可以使用萬能的IntPtr類型在Managed 程式碼中定義.然而本專題只是對資料封送做一個入門的介紹, 要真真掌握資料封送處理還要考慮很多其他的因素,這個就需要大家在平時工作中積累的。

[轉]C# 互通性入門系列(三)：平台叫用中的資料封送處理