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}");
        }
    }
}

 

运行结果也是正常的。