封送带字符串指针的结构体参数到非托管函数

╰半橙微兮° 2022-02-24 17:27 154阅读 0赞

在NET项目开发过程中，经常会遇到向非托管代码封送结构体的情况，如果结构体中仅包含blittable类型/字符串/字符数组类型字段，仅需要在C\#中重新声明该结构体并将该结构体作为参数传递到非托管函数即可。但若结构体中包含了指向字符串的指针，情况会稍微复杂些。

非托管结构体代码如下：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>struct</code> 
      <code>ParamType </code> 
     </div> 
     <div> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>wchar_t</code> 
      <code>* JobBond; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//字符串数组的个数 </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>int</code> 
      <code>Size; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//字符串数组 </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>wchar_t</code> 
      <code>** NameList; </code> 
     </div> 
     <div> 
      <code>};</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>extern</code> 
      <code>"C"</code> 
      <code>__declspec</code> 
      <code>(</code> 
      <code>dllexport</code> 
      <code>) </code> 
      <code>void</code> 
      <code>WINAPI Report(ParamType ParamList[], </code> 
      <code>int</code> 
      <code>Size) </code> 
     </div> 
     <div> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>for</code> 
      <code>(</code> 
      <code>int</code> 
      <code>i = 0; i &lt; Size; i ++) </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>ParamType Param = ParamList[i]; </code> 
     </div> 
     <div> 
      <code>&nbsp;</code>&nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>wprintf(_T(</code> 
      <code>"%s\n"</code> 
      <code>), Param.JobBond); </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>for</code> 
      <code>(</code> 
      <code>int</code> 
      <code>j = 0; j &lt; Param.Size; j ++) </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>wprintf(_T(</code> 
      <code>"\t%s\n"</code> 
      <code>), Param.NameList[j]); </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>} </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>} </code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

C\#中以string代表wchar\_t\*，如非托管函数参数直接为wchar\_t\*\*，可以用ref string或out string表示指向字符串的指针。但上述示例wchar\_t\*\*存在于结构体中，对于这类指针在C\#中采用IntPtr。

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)] </code> 
     </div> 
     <div> 
      <code>public</code> 
      <code> struct</code> 
      <code>ParamType </code> 
     </div> 
     <div> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>string</code> 
      <code>JobBond; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>int</code> 
      <code>Size; </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>public</code> 
      <code>IntPtr NameList; </code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

下面需要获取字符串数组的首地址，C\#中有两种方式可以获取数组的首地址：GCHandle的AddrOfPinnedObject和Marshal.UnsafeAddrOfPinnedArrayElement方法。但GCHandle无法Pinned引用类型数组，MSDN中又指明Marshal.UnsafeAddrOfPinnedArrayElement方法调用前需Pinned指定的数组。看来必须设法将字符串数组转换为值类型数组，完整代码如下：

[?][Link 1]

<table> 
 <tbody> 
  <tr> 
   <td> 
    <div>
      1 
    </div> 
    <div>
      2 
    </div> 
    <div>
      3 
    </div> 
    <div>
      4 
    </div> 
    <div>
      5 
    </div> 
    <div>
      6 
    </div> 
    <div>
      7 
    </div> 
    <div>
      8 
    </div> 
    <div>
      9 
    </div> 
    <div>
      10 
    </div> 
    <div>
      11 
    </div> 
    <div>
      12 
    </div> 
    <div>
      13 
    </div> 
    <div>
      14 
    </div> 
    <div>
      15 
    </div> 
    <div>
      16 
    </div> 
    <div>
      17 
    </div> 
    <div>
      18 
    </div> 
    <div>
      19 
    </div> 
    <div>
      20 
    </div> 
    <div>
      21 
    </div> 
    <div>
      22 
    </div> 
    <div>
      23 
    </div> 
    <div>
      24 
    </div> 
    <div>
      25 
    </div> 
    <div>
      26 
    </div> 
    <div>
      27 
    </div> 
    <div>
      28 
    </div> 
    <div>
      29 
    </div> 
    <div>
      30 
    </div> 
    <div>
      31 
    </div> 
    <div>
      32 
    </div> 
    <div>
      33 
    </div> 
    <div>
      34 
    </div> 
    <div>
      35 
    </div> 
    <div>
      36 
    </div> 
    <div>
      37 
    </div> 
    <div>
      38 
    </div> 
    <div>
      39 
    </div> 
    <div>
      40 
    </div> 
    <div>
      41 
    </div> 
    <div>
      42 
    </div> 
    <div>
      43 
    </div> 
    <div>
      44 
    </div> 
    <div>
      45 
    </div> 
    <div>
      46 
    </div> 
    <div>
      47 
    </div> 
    <div>
      48 
    </div> </td> 
   <td> 
    <div> 
     <div> 
      <code>List&lt;ParamType&gt; paramList = </code> 
      <code>new</code> 
      <code>List&lt;ParamType&gt;(); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>ParamType param1; </code> 
     </div> 
     <div> 
      <code>param1.JobBond = </code> 
      <code>"Engineer"</code> 
      <code>; </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>IntPtr[] namePtr1 = </code> 
      <code>new</code> 
      <code>IntPtr[3]; </code> 
     </div> 
     <div> 
      <code>//将字符串存储到非托管内存中并返回字符串地址 </code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>namePtr1[0] = Marshal.StringToCoTaskMemUni(</code> 
      <code>"Desmond, Wang"</code> 
      <code>); </code> 
     </div> 
     <div> 
      <code>namePtr1[1] = Marshal.StringToCoTaskMemUni(</code> 
      <code>"Jerry, Lin"</code> 
      <code>); </code> 
     </div> 
     <div> 
      <code>namePtr1[2] = Marshal.StringToCoTaskMemUni(</code> 
      <code>"Penny"</code> 
      <code>); </code> 
     </div> 
     <div> 
      <code>//将namePtr1对象固定在内存中，防止垃圾收集器调整内存以致指针失效 </code> 
     </div> 
     <div> 
      <code>&nbsp;</code> 
      <code>GCHandle gch1 = GCHandle.Alloc(namePtr1, GCHandleType.Pinned); </code> 
     </div> 
     <div> 
      <code>param1.NameList = gch1.AddrOfPinnedObject(); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>param1.Size = namePtr1.Length; </code> 
     </div> 
     <div> 
      <code>paramList.Add(param1); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>ParamType param2; </code> 
     </div> 
     <div> 
      <code>param2.JobBond = </code> 
      <code>"Expert"</code> 
      <code>; </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>IntPtr[] namePtr2 = </code> 
      <code>new</code> 
      <code>IntPtr[2]; </code> 
     </div> 
     <div> 
      <code>namePtr2[0] = Marshal.StringToCoTaskMemUni(</code> 
      <code>"Petter"</code> 
      <code>); </code> 
     </div> 
     <div> 
      <code>namePtr2[1] = Marshal.StringToCoTaskMemUni(</code> 
      <code>"Jordan"</code> 
      <code>); </code> 
     </div> 
     <div> 
      <code>GCHandle gch2 = GCHandle.Alloc(namePtr2, GCHandleType.Pinned); </code> 
     </div> 
     <div> 
      <code>param2.NameList = gch2.AddrOfPinnedObject(); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>param2.Size = namePtr2.Length; </code> 
     </div> 
     <div> 
      <code>paramList.Add(param2); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>ParamType[] test = paramList.ToArray(); </code> 
     </div> 
     <div> 
      <code>try</code> 
     </div> 
     <div> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Report(test, test.Length); </code> 
     </div> 
     <div> 
      <code>} </code> 
     </div> 
     <div> 
      <code>finally </code> 
     </div> 
     <div> 
      <code>{ </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//释放固定对象，否则会导致内存泄漏，导致程序性能下降 </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>gch1.Free(); </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>gch2.Free(); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>//释放非托管内存，避免内存泄漏 </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>foreach (var ptr in namePtr1) </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Marshal.FreeCoTaskMem(ptr); </code> 
     </div> 
     <div>
       &nbsp; 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>foreach (var ptr in namePtr2) </code> 
     </div> 
     <div> 
      <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> 
      <code>Marshal.FreeCoTaskMem(ptr); </code> 
     </div> 
     <div> 
      <code>}</code> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

[?][Link 1]

运行结果：

[![image][]][image 1]

转载请注明出处：

[http://www.cnblogs.com/desmondwang/archive/2011/12/18/MarshalStructWithStrPtr.html][http_www.cnblogs.com_desmondwang_archive_2011_12_18_MarshalStructWithStrPtr.html]

[Link 1]: http://www.cnblogs.com/desmondwang/archive/2011/12/18/MarshalStructWithStrPtr.html#
[image]: /images/20220224/a544a06a1ab54313b239b64d35cb1f35.png
[image 1]: http://images.cnblogs.com/cnblogs_com/desmondwang/201112/201112182246465400.png
[http_www.cnblogs.com_desmondwang_archive_2011_12_18_MarshalStructWithStrPtr.html]: http://www.cnblogs.com/desmondwang/archive/2011/12/18/MarshalStructWithStrPtr.html