[C#]P/Invokeで構造体配列を含む構造体を渡す方法

Question

困っていること

C言語で書かれたDLLがあり、C#からここに定義された関数を呼び出したいと思っています。
しかし、P/Invoke時に関数に渡すべきクラスをどう作れば良いのか分からず困っています。

C#から関数を呼び出す際は以下のように定義したものを呼んでいます。

[DllImport("test.dll", EntryPoint="TestFunction")]
public static extern int TestFunction([Out]ResultInfo result);

要するにTestFunction関数に ResultInfo 型の変数を渡すと そこに結果が入るだけなのですが、この ResultInfo が厄介です。

C側で定義されたResultInfo は構造体で、以下のように定義されています。

ResultInfo構造体
int	id
Item[100]	items

ResultInfo構造体の中に、Item構造体の配列を含んでいます。
Item構造体は以下のように定義されています。

Item構造体
int	itemid
char[64]	name

このような場合、C#側ではResultInfoとItemをどう定義したら良いのでしょうか。

現状

以下のように定義しましたが、正しく動作しません。

/* ResultInfo.cs */
[StructLayout(LayoutKind.Sequential)]
public class ResultInfo
{
    public string id;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst=100)]
    public Item[] items;
}

/* Item.cs */
[StructLayout(LayoutKind.Sequential)]
public class Item
{
    public int itemid;
    [MarshalAs(UnmanagementType.ByValTStr, SizeConst=64)]
    public string name;
}

/* 関数の呼び出し */
var resultInfo = new ResultInfo();
var resultCode = TestFunction(resultInfo);

この結果、DLLに定義されている関数自体は呼び出され、引数に渡したresultInfoの中のresultInfo.idには正しい値がセットされています。
しかし、resultInfo.itemsの中身は全てnullとなってしまいます。
少なくとも呼び出しには成功しているようなので、itemsが全てnullになってしまうのはC#側の定義が悪いのだろうと思っています。
どのように修正したら良いのでしょうか。

その他

ここで問題としているてtest.dllは仮の名前であり、実際はサードパーティ製のライブラリのためデバッグができません。

追記 (2017.08.27 20:00)

以下のように変更をしたら状況が進みました。

• ResultInfoクラスの定義をclassからstructに変更
• Itemクラスの定義をclassからstructに変更
• C#のTestMethodの引数を [Out]ResultInfo result → IntPtr result に変更
• 関数の呼び出し方を以下のように変更

var resultInfo = new ResultInfo();
// var resultCode = TestFunction(resultInfo);
IntPtr p = Marshal.AllocCoTaskMem(Marshal.SizeOf(resultInfo));
Marshal.StructureToPtr(resultInfo, p, false);
var resultCode = TaskFunction(p);
ResultInfo res = (ResultInfo)Marshal.PtrToStructure(p, typeof(ResultInfo));
Marshal.FreeCoTaskMem(p);

この結果、ResultInfo.items（ここでは変数res）の中身が全てnullという状態は改善し、中身は全てItem型のオブジェクトになりました。
しかし、ResultInto.items[0].itemid には値が入っている状態ですが、ResultInfo.items[0].name はnullになってしまいます。
（本来はResultInfo.items[0].nameには空文字列またはSJISの文字列が入り、nullが入ることはありません）

Comments

[ebiryo]

C++/CLIでラップしちゃったほうが手っ取り早い気がするのですが。。　制限等があるのでしょうか？

[kmz_kappa]

ありがとうございます。まず私がC++/CLIでラップする方法を知らないことと、調べて実装をしたとしてもC++/CLIの知識が必要なため自分以外の人間が保守をすることができなくなることが課題となってしまいます。

Answer 1

こんな感じでしょうか。

[DllImport("test.dll", EntryPoint="TestFunction")]
public static extern int TestFunction([Out,In]ref ResultInfo result);

/* ResultInfo.cs */
[StructLayout(LayoutKind.Sequential)]
public struct ResultInfo
{
    public int id;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst=100)]
    public Item[] items;
}

/* Item.cs */
[StructLayout(LayoutKind.Sequential, CharSet=CharSet.Ansi)]
public struct Item
{
    public int itemid;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst=64)]
    public string name;
}

/* 関数の呼び出し */
var resultInfo = new ResultInfo();
resultInfo.items = new Item[100];
for(int i = 0; i < 100; i++)
{
	resultInfo.items[i] = new Item();
	resultInfo.items[i].name = "";
}
var resultCode = TestFunction(ref resultInfo);

変更点

• classをstructに変更
• idをintに変更
• ItemにCharSet=CharSet.Ansiを追加
• 構造体のメンバを初期化
• パラメータを参照で渡す

一番最初のコードがうまくいかない原因の最も大きな点は、クラスのメンバが初期化されていないことです。

Comments

[kmz_kappa]

ありがとうございます。
散々悩んで書いていましたが、メンバの値が初期化がされていないことが問題だったとは恥ずかしいです。
メモリだけ確保してC側の処理に投げてしまえばどうにかなるのだろうと思っていました。
お陰様でIntPtrを使わず簡潔に処理を記述することができました。

Answer 2

自己解決しました。

処理結果に含まれるstringがnullになってしまう原因は、C側の処理で構造体メンバのchar[]にSJISの文字列がセットされることにありました。
C側の処理でchar[]にSJIS文字列がセットされた後、これを.NETは文字コードを考慮せずstringに変換しました。
その結果stringの値は壊れてしまい、デバッガからはstringの値がnullになったように見えました。

これを回避するために定義を以下のように変更し、C側の処理結果をstringではなくbyte[]で受け取るようにしました。

// [MarshalAs(UnmanagedType.ByValTStr, SizeConst=64)]
// public string name;
[MarshalAs(UnmanagedType.ByValArray, ArraySubType=UnmanagedType.ByValTStr, SizeConst=64)]
public byte[] name;

そして、nameの値をbyte[]から文字コードを考慮してstringに変換することで期待した結果が得られました。

string str = System.Text.Encoding.GetEncoding("Shift_JIS").GetString(name);