C# 将指向结构(包含非 blittable 类型)的指针传递给非托管 C++ DLL

Question

我尝试在我的 C# 代码中使用 C++ DLL。
所有读取的数据都必须作为指向结构的指针传递给 dll。我的第一个想法是只保留一些非托管内存，将指针传递给函数，然后提取数据。问题是这些函数只会返回一个错误代码，该代码转换为“参数无效”。

来自 DLL header (Result 和 BusPortId 缩短)

typedef enum {
    BUS_COM1 = 0x01,  // 2 to 15 ommited
    BUS_COM16 = 0x10,
    BUS_USB1 = 0x101,  // 2 to 15 ommited
    BUS_USB16 = 0x110
} BusPortId;

typedef enum {
    BUS_SUCCESS    = 0,     //!< The operation was completed successfully
    BUS_ERROR      = 0x100,  //!< An error occured
    BUS_INVALIDARG = 0x1000, //!< An argument is not valid
} Result


struct BusPortInfo
{
    ULONG       portInfoSize;
    CHAR        portText[64];
    BOOL        portLocked;
    BusPortId   portId;
};

Result BUSDRV_API busGetAvailablePortCount( ULONG *retCount );

Result BUSDRV_API busGetAvailablePort( ULONG index, BusPortInfo *portInfo );

到目前为止我的 C# 程序的相关部分

enum BusPortId
{
    BUS_COM1 = 0x01,  // 2 to 15 ommited
    BUS_COM16 = 0x10,
    BUS_USB1 = 0x101,  // 2 to 15 ommited
    BUS_USB16 = 0x110
};

public enum Result
{
    BUS_SUCCESS = 0,       //!< The operation was completed successfully
    BUS_ERROR = 0x100,  //!< An error occured
    BUS_INVALIDARG = 0x1000, //!< An argument is not valid
};

struct BusPortInfo
{
    public ULONG portInfoSize;
    unsafe public fixed char portText[64];
    public BOOL portLocked;
    public BusPortId portId;
}

[DllImport(DLL_Path)]
unsafe static extern Result busGetAvailablePortCount(ULONG* retCount);
[DllImport(DLL_Path)]
unsafe static extern Result busGetAvailablePort(ULONG index, BusPortInfo* portInfo);

ulong count= 0;
Result res = busGetAvailablePortCount(&count);

ulong index = 0;
BusPortInfo info = new BusPortInfo();
Result res = busGetAvailablePort(0, &info);

对 busGetAvailablePortCount(和其他类似函数)的调用没有任何问题。但是当我调用 busGetAvailablePort 时，我在控制台输出中得到以下内容

无法编码“参数 #2”:指针无法引用已编码的结构。请改用 ByRef。

问题是我可以在 C# 中更改我的结构，以便我可以传递指针，但是 DLL 中的函数也会返回“参数无效”

我必须对我的结构做些什么才能将指向它的指针传递给函数，同时仍被 DLL 接受？

附言抱歉英语不好，我不是母语人士。

Answer 1

这些声明有很多问题，当程序员不断修改代码以尝试使 pinvoke 调用工作时，往往会发生这些问题。最可能正确的结构声明是:

    [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
    struct BusPortInfo {
        public int portInfoSize;
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)]
        public string portText;
        public bool portLocked;
        public BusPortId portId;
    }

强调 native 代码中的 ULONG 是 32 位类型，fixed 只是没有必要，而且非常尴尬。由于 bool 和 string 成员，这个结构不可 blittable，没什么好担心的。

[DllImport] 声明需要正确声明第二个参数。 CallingConvention 属性总是很重要，我们看不到 BUSDRV_API 的含义。平底船:

    [DllImport(DLL_Path, CallingConvention = CallingConvention.StdCall)]
    static extern Result busGetAvailablePortCount(out int retCount );

    [DllImport(DLL_Path, CallingConvention = CallingConvention.StdCall)]
    static extern Result busGetAvailablePort(int index, 
                            [In, Out] ref BusPortInfo portInfo);

调用看起来不正确。当结构具有“大小”成员时，api 契约(Contract)通常要求在调用之前设置它。这是一种安全措施，它确保当调用者使用错误的结构声明时 api 不会破坏内存。当设置错误时，“无效参数”错误是预期的结果。所以写成类似于:

int count;
Result res = busGetAvailablePortCount(out count);
if (res != Result.BUS_SUCCESS) throw new Exception("Api failure " + res.ToString());

for (int ix = 0; ix < count; ++ix) {
    BusPortInfo info;
    info.portInfoSize = Marshal.SizeOf(typeof(BusPortInfo));   // Important!
    res = busGetAvailablePort(ix, ref info);
    if (res != Result.BUS_SUCCESS) throw new Exception("Api failure " + res.ToString());
    // etc...
}

当然没有测试，应该在大概范围内。如果仍有问题，请验证 native 代码中的 sizeof(BusPortInfo) 是否与 C# 中的 Marshal.SizeOf(typeof(BusPortInfo)) 的值匹配。如果全部失败，则改用 C++/CLI，这样您就可以直接使用 native 声明。并与 DLL 的所有者联系以获得正确的使用说明，最好他会为您编写一个 pinvoke 示例。