将 std::wstring 的内容从 C++ 返回到 C#

Posted 2023-02-22

【中文标题】将 std::wstring 的内容从 C++ 返回到 C#

【英文标题】：Return contents of a std::wstring from C++ into C#

【发布时间】：2011-08-13 14:39:53

【问题描述】：

我有一个非托管 C++ DLL，我用一个简单的 C 接口包装了它，因此我可以从 C# 调用 PInvoke。这是 C 包装器中的示例方法：

const wchar_t* getMyString()

    // Assume that someWideString is a std::wstring that will remain
    // in memory for the life of the incoming calls.
    return someWideString.c_str();

这是我的 C# DLLImport 设置。

[DllImport( "my.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl )]
private static extern string GetMyString();

但是字符串没有正确编组，经常把第一个字符搞砸，或者有时会显示一堆中文字符。我已经记录了 C 端实现的输出，以确认 std::wstring 格式正确。

我还尝试更改 DLLImport 以返回 IntPtr 并使用 Marshal.PtrToStringUni 使用包装方法进行转换，结果相同。

[DllImport( "my.dll", CallingConvention = CallingConvention.Cdecl )]
private static extern IntPtr GetMyString();
public string GetMyStringMarshal()

    return Marshal.PtrToStringUni( GetMyString() );

有什么想法吗？

更新答案

如下所述，这并不是我的绑定的真正问题，而是我的 wchar_t* 的生命周期。我的书面假设是错误的， someWideString 实际上是在我调用应用程序的其余部分时被复制的。因此它只存在于堆栈中，并且在我的 C# 代码完成编组之前被释放。

正确的解决方案是按照 shf301 的描述将指针传递给我的方法，或者确保我的 wchar_t* 引用在我的 C# 接口有时间复制它之前不会被移动/重新分配/销毁。

将 std::wstring 作为“const &std::wstring”返回到我的 C 层意味着我对 c_str() 的调用将返回一个引用，该引用不会在我的 C 方法范围之外立即被释放.

然后，调用 C# 代码需要使用 Marshal.PtrToStringUni() 将数据从引用复制到托管字符串中。

【问题讨论】：

那么，问题是什么？

显然我也无法使用键盘并在完成问题之前提交。

也许this question 有帮助？

遇到这个问题的人可能会发现这两篇文章很方便：Returning Strings 和 Using StringBuilder。

【参考方案1】：

由于Hans Passant's answer 中提到的原因，您将不得不重写您的 getMyString 函数。

您需要让 C# 代码将缓冲区传递给您的 C++ 代码。这样，您的代码（好的，CLR Marshaller）控制缓冲区的生命周期，并且您不会陷入任何未定义的行为。

下面是一个实现：

C++

void getMyString(wchar_t *str, int len)

    wcscpy_s(str, len, someWideString.c_str());

C#

[DllImport( "my.dll", CallingConvention = CallingConvention.Cdecl, CharSet = CharSet.Unicode )]
private static extern void GetMyString(StringBuffer str, int len);
public string GetMyStringMarshal()

    StringBuffer buffer = new StringBuffer(255);
    GetMyString(buffer, buffer.Capacity);
    return buffer.ToString();

【讨论】：

它的意思是StringBuilder 而不是StringBuffer？

【参考方案2】：

需要为返回值指定 MarshalAs 属性：

    [DllImport( "my.dll", CharSet = CharSet.Unicode, CallingConvention = CallingConvention.Cdecl)]
    [return : MarshalAs(UnmanagedType.LPWStr)]
    private static extern string GetMyString();

确保函数确实是 cdecl 并且在函数返回时 wstring 对象没有被破坏。

【讨论】：

遗憾的是，PInvoke 将在指定 LPWStr 时释放内存，因此您必须使用 CoTaskMemAlloc 分配返回值。

这将使程序在 Vista 和 Windows 7 上崩溃，pinvoke marshaller 将尝试使用 CoTaskMemFree() 释放字符串。 XP 上没有崩溃，它忽略了无效的堆指针。需要返回 IntPtr 以避免使编组器认为字符串需要释放。