P/Invoke各種總結（一、使用StructLayout特性來控制內存結構）

C#在調用WInAPI函數時，可能會看到如下的聲明

[StructLayout(LayoutKind.Sequential)]
        public struct RECT
        {
            public int Left;
            public int Top;
            public int Right;
            public int Bottom;
        }

在類或者結構體前面帶上了

[StructLayout(LayoutKind.Sequential)]

StructLayoutAttribute特性的作用是允許你控制內存中類或結構的數據字段的物理布局。

平常我們在C#代碼中使用類或者結構體時，不需要使用此特性。但在與非托管代碼時交互，需要使用StructLayoutAttribute特性來控制類型的非托管布局。

 

StructLayoutAttribute常用構造函數是：

StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind)

System.Runtime.InteropServices.LayoutKind是一個枚舉類型，有三個取值。

 

LayoutKind.Sequential

強制按成員的顯示順序對其進行排列。對於blittable類型，在托管和非托管內存中控制布局。對於non-blittable類型，它會在將類或者結構體封送到非托管代碼時控制布局（換言之，如果僅在C#中進行調用，不會做任何操作，在與非托管代碼交互時，僅控制送入非托管代碼的布局）

LayoutKind.Explicit

控制每個數據成員的精確位置，這會影響托管和非托管代碼中的布局，不管是blittable類型還是non-blittable類型。（Blittable and Non-Blittable Types介紹），使用LayoutKind.Explicit時，需要使用FieldOffsetAttribute特性指示類型中每個字段的位置。

 

默認情況下，編譯器會將LayoutKind.Sequential應用到結構體，對於類，需要顯式應用LayoutKind.Sequential值。

到這里也就明白了，以后在調用API函數時，如果使用的是結構體，就不再需要下面這句代碼了。

[StructLayout(LayoutKind.Sequential)]

下面用示例代碼說明一下

這里以獲取桌面窗體的寬高為例，需要用到的API函數是

HWND GetDesktopWindow();

BOOL GetWindowRect(HWND hWnd, LPRECT lpRect );

其中LPRECT是指向RECT結構體的指針，RECT結構聲明如下：

typedef struct tagRECT {
  LONG left;
  LONG top;
  LONG right;
  LONG bottom;
} RECT, *PRECT, *NPRECT, *LPRECT;

使用結構體時，調用代碼如下：

using System;
using System.Runtime.InteropServices;

namespace ConsoleApp10
{
    public struct RECT
    {
        public int Left;
        public int Top;
        public int Right;
        public int Bottom;
    }

    class Program
    {
        [DllImport("user32.dll")]
        private static extern IntPtr GetDesktopWindow();

        [DllImport("user32.dll", SetLastError = true)]
        private static extern int GetWindowRect(IntPtr hwnd, out RECT rc);

        static void Main(string[] args)
        {
            IntPtr hwnd = GetDesktopWindow();
            RECT rect;
            GetWindowRect(hwnd, out rect);
            Console.WriteLine($"Left:{rect.Left},Top:{rect.Top},Right:{rect.Right},Bottom:{rect.Bottom}");
        }
    }
}

運行結果如下：

 

下面我們來看一下，把結構體換成類的情況

using System;
using System.Runtime.InteropServices;

namespace ConsoleApp10
{
    public class RECT
    {
        public int Left;
        public int Top;
        public int Right;
        public int Bottom;
    }

    class Program
    {
        [DllImport("user32.dll")]
        private static extern IntPtr GetDesktopWindow();

        [DllImport("user32.dll", SetLastError = true)]
        private static extern int GetWindowRect(IntPtr hwnd,RECT rc);

        static void Main(string[] args)
        {
            IntPtr hwnd = GetDesktopWindow();
            RECT rect = new RECT();
            GetWindowRect(hwnd, rect);
            Console.WriteLine($"Left:{rect.Left},Top:{rect.Top},Right:{rect.Right},Bottom:{rect.Bottom}");
        }
    }
}

運行結果如下：

運行結果並不正常

把類修改一下，帶上[StructLayout(LayoutKind.Sequential)]

    [StructLayout(LayoutKind.Sequential)]
    public class RECT
    {
        public int Left;
        public int Top;
        public int Right;
        public int Bottom;
    }

再次運行，發現結果正常了

 

最后再看看LayoutKind.Explicit的情況，調用代碼如下

using System;
using System.Runtime.InteropServices;

namespace ConsoleApp10
{
    [StructLayout(LayoutKind.Explicit)]
    public class RECT
    {
        [FieldOffset(0)]public int Left; //FieldOffset用於指示類或結構的非托管表示形式中字段的物理位置
        [FieldOffset(4)]public int Top;
        [FieldOffset(8)]public int Right;
        [FieldOffset(12)]public int Bottom;
    }

    class Program
    {
        [DllImport("user32.dll")]
        private static extern IntPtr GetDesktopWindow();

        [DllImport("user32.dll", SetLastError = true)]
        private static extern int GetWindowRect(IntPtr hwnd,[MarshalAs(UnmanagedType.LPStruct)]RECT rc);

        static void Main(string[] args)
        {
            IntPtr hwnd = GetDesktopWindow();
            RECT rect = new RECT();
            GetWindowRect(hwnd, rect);
            Console.WriteLine($"Left:{rect.Left},Top:{rect.Top},Right:{rect.Right},Bottom:{rect.Bottom}");
        }
    }
}

 

運行結果也是正常的。