调用 COM 方法在 C# 中抛出无法解释的 COMException,在 C++ 中工作正常
Calling COM method throws unexplainable COMException in C#, works fine in C++
我正在通过示例学习如何在 C# 中使用 COM 接口,因此我为 (I)DxDiagProvider
和 IDxDiagContainer
COM 对象编写了一个 coclass 和接口。
然而,虽然表面上等效的代码在 C++ 中运行良好,但在 C# 中调用其中一个方法失败并显示 COMException
(HRESULT 为 -1)。我可能在将它移植到 C# 时搞砸了,但看不到错误。
本机代码(有效)
对象在原始 C 中定义如下,这也是我对它们的唯一信息(没有用于 tlbimp 或任何东西的库):
struct IDxDiagContainerVtbl;
struct IDxDiagContainer { IDxDiagContainerVtbl* lpVtbl; };
struct IDxDiagContainerVtbl
{
HRESULT(__stdcall* QueryInterface)(IDxDiagContainer* This, const IID* const riid, void** ppvObject);
ULONG(__stdcall* AddRef)(IDxDiagContainer* This);
ULONG(__stdcall* Release)(IDxDiagContainer* This);
HRESULT(__stdcall* EnumChildContainerNames)(IDxDiagContainer* This, DWORD dwIndex, LPWSTR pwszContainer, DWORD cchContainer);
HRESULT(__stdcall* EnumPropNames)(IDxDiagContainer* This, DWORD dwIndex, LPWSTR pwszPropName, DWORD cchPropName);
HRESULT(__stdcall* GetChildContainer)(IDxDiagContainer* This, LPCWSTR pwszContainer, IDxDiagContainer** ppInstance);
HRESULT(__stdcall* GetNumberOfChildContainers)(IDxDiagContainer* This, DWORD* pdwCount);
HRESULT(__stdcall* GetNumberOfProps)(IDxDiagContainer* This, DWORD* pdwCount);
HRESULT(__stdcall* GetProp)(IDxDiagContainer* This, LPCWSTR pwszPropName, VARIANT* pvarProp);
};
struct DXDIAG_INIT_PARAMS
{
DWORD dwSize;
DWORD dwDxDiagHeaderVersion;
BOOL bAllowWHQLChecks;
void* pReserved;
};
struct IDxDiagProviderVtbl;
struct IDxDiagProvider { IDxDiagProviderVtbl* lpVtbl; };
struct IDxDiagProviderVtbl
{
HRESULT(__stdcall* QueryInterface)(IDxDiagProvider* This, const IID* const riid, void** ppvObject);
ULONG(__stdcall* AddRef)(IDxDiagProvider* This);
ULONG(__stdcall* Release)(IDxDiagProvider* This);
HRESULT(__stdcall* Initialize)(IDxDiagProvider* This, DXDIAG_INIT_PARAMS* pParams);
HRESULT(__stdcall* GetRootContainer)(IDxDiagProvider* This, IDxDiagContainer** ppInstance);
};
在本机 C++ 中创建并调用 Initialize
工作正常:
int main()
{
GUID clsid;
GUID iid;
CLSIDFromString(L"{A65B8071-3BFE-4213-9A5B-491DA4461CA7}", &clsid);
CLSIDFromString(L"{9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2}", &iid);
CoInitialize(NULL);
IDxDiagProvider* pDxDiagProvider;
HRESULT hr = CoCreateInstance(clsid, NULL, 1, iid, (LPVOID*)&pDxDiagProvider); // S_OK
DXDIAG_INIT_PARAMS params;
params.dwSize = sizeof(DXDIAG_INIT_PARAMS);
params.dwDxDiagHeaderVersion = 111;
params.bAllowWHQLChecks = 0;
params.pReserved = 0;
// Sorry for the C-like access, I don't have anything better than the structs above.
hr = pDxDiagProvider->lpVtbl->Initialize(pDxDiagProvider, ¶ms); // S_OK
}
托管代码(损坏)
然后我继续将其移植到具有以下定义的 STAThread
x86 .NET 4.6.1 C# 控制台程序:
[ComImport]
[Guid("A65B8071-3BFE-4213-9A5B-491DA4461CA7")]
public class DxDiagProvider { }
[Guid("9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2")]
public interface IDxDiagProvider
{
void Initialize(ref DXDIAG_INIT_PARAMS pParams);
void GetRootContainer(ref IDxDiagContainer ppInstance);
}
[StructLayout(LayoutKind.Sequential)]
public struct DXDIAG_INIT_PARAMS
{
public uint dwSize;
public uint dwDxDiagHeaderVersion;
public bool bAllowWHQLChecks;
public IntPtr pReserved;
};
[Guid("7D0F462F-4064-4862-BC7F-933E5058C10F")]
public interface IDxDiagContainer
{
void EnumChildContainerNames(uint dwIndex, string pwszContainer, uint cchContainer);
void EnumPropNames(uint dwIndex, string pwszPropName, uint cchPropName);
void GetChildContainer(string pwszContainer, ref IDxDiagContainer ppInstance);
void GetNumberOfChildContainers(ref uint pdwCount);
void GetNumberOfProps(ref uint pdwCount);
void GetProp(string pwszPropName, ref IntPtr pvarProp);
}
现在,在创建 class 和转换接口时,对 Initialize
的调用中断 COMException: Exception from HRESULT: 0xFFFFFFFF
:
[STAThread]
static void Main(string[] args)
{
// Working fine.
DxDiagProvider dxDiagProviderClass = new DxDiagProvider();
IDxDiagProvider dxDiagProvider = (IDxDiagProvider)dxDiagProviderClass;
DXDIAG_INIT_PARAMS initParams = new DXDIAG_INIT_PARAMS
{
dwSize = (uint)Marshal.SizeOf<DXDIAG_INIT_PARAMS>(),
dwDxDiagHeaderVersion = 111
};
dxDiagProvider.Initialize(ref initParams); // causes COMException
}
我不确定我做错了什么。到目前为止,我已经测试并检查了以下内容:
- 确保
DXDIAG_INIT_PARAMS
结构的大小、对齐、布局正确
- 确保我的方法顺序正确并且我没有添加
IUnknown
方法
- 尝试将
DispIdAttribute
添加到接口方法中,尽管我认为这仅在托管 COM 对象而不使用它们时相关。
- 尝试将参数作为非引用传递,即使它们应该是
ref
因为参数是指针。
我真的希望这与 COM 对象在托管应用程序中使用时无法正常工作无关(这肯定会使这个问题过于宽泛)。所以我想至少确保我的方法和定义是正确的。是否还有其他必须完成但我遗漏的事情?
我发现我遗漏了什么并且可以修复它:
显然,我忘记用 InterfaceTypeAttribute
修饰 C# 接口并指定 ComInterfaceType.InterfaceIsIUnknown
。至少对于这些 COM 对象,这是必需的,因为默认 ComInterfaceType.InterfaceIsDual
会导致 COMException
被抛出。
例如,接口定义现在在 C# 中看起来像这样(另外我修复了一些 ref
到 out
参数,但是这不是这个问题的原因):
[Guid("9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] // <-- need this
public interface IDxDiagProvider
{
void Initialize(ref DXDIAG_INIT_PARAMS pParams);
void GetRootContainer(out IDxDiagContainer ppInstance);
}
[Guid("7D0F462F-4064-4862-BC7F-933E5058C10F")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] // <-- need this
public interface IDxDiagContainer
{
void EnumChildContainerNames(uint dwIndex, string pwszContainer, uint cchContainer);
void EnumPropNames(uint dwIndex, string pwszPropName, uint cchPropName);
void GetChildContainer(string pwszContainer, out IDxDiagContainer ppInstance);
void GetNumberOfChildContainers(out uint pdwCount);
void GetNumberOfProps(out uint pdwCount);
void GetProp(string pwszPropName, out IntPtr pvarProp);
}
我正在通过示例学习如何在 C# 中使用 COM 接口,因此我为 (I)DxDiagProvider
和 IDxDiagContainer
COM 对象编写了一个 coclass 和接口。
然而,虽然表面上等效的代码在 C++ 中运行良好,但在 C# 中调用其中一个方法失败并显示 COMException
(HRESULT 为 -1)。我可能在将它移植到 C# 时搞砸了,但看不到错误。
本机代码(有效)
对象在原始 C 中定义如下,这也是我对它们的唯一信息(没有用于 tlbimp 或任何东西的库):
struct IDxDiagContainerVtbl;
struct IDxDiagContainer { IDxDiagContainerVtbl* lpVtbl; };
struct IDxDiagContainerVtbl
{
HRESULT(__stdcall* QueryInterface)(IDxDiagContainer* This, const IID* const riid, void** ppvObject);
ULONG(__stdcall* AddRef)(IDxDiagContainer* This);
ULONG(__stdcall* Release)(IDxDiagContainer* This);
HRESULT(__stdcall* EnumChildContainerNames)(IDxDiagContainer* This, DWORD dwIndex, LPWSTR pwszContainer, DWORD cchContainer);
HRESULT(__stdcall* EnumPropNames)(IDxDiagContainer* This, DWORD dwIndex, LPWSTR pwszPropName, DWORD cchPropName);
HRESULT(__stdcall* GetChildContainer)(IDxDiagContainer* This, LPCWSTR pwszContainer, IDxDiagContainer** ppInstance);
HRESULT(__stdcall* GetNumberOfChildContainers)(IDxDiagContainer* This, DWORD* pdwCount);
HRESULT(__stdcall* GetNumberOfProps)(IDxDiagContainer* This, DWORD* pdwCount);
HRESULT(__stdcall* GetProp)(IDxDiagContainer* This, LPCWSTR pwszPropName, VARIANT* pvarProp);
};
struct DXDIAG_INIT_PARAMS
{
DWORD dwSize;
DWORD dwDxDiagHeaderVersion;
BOOL bAllowWHQLChecks;
void* pReserved;
};
struct IDxDiagProviderVtbl;
struct IDxDiagProvider { IDxDiagProviderVtbl* lpVtbl; };
struct IDxDiagProviderVtbl
{
HRESULT(__stdcall* QueryInterface)(IDxDiagProvider* This, const IID* const riid, void** ppvObject);
ULONG(__stdcall* AddRef)(IDxDiagProvider* This);
ULONG(__stdcall* Release)(IDxDiagProvider* This);
HRESULT(__stdcall* Initialize)(IDxDiagProvider* This, DXDIAG_INIT_PARAMS* pParams);
HRESULT(__stdcall* GetRootContainer)(IDxDiagProvider* This, IDxDiagContainer** ppInstance);
};
在本机 C++ 中创建并调用 Initialize
工作正常:
int main()
{
GUID clsid;
GUID iid;
CLSIDFromString(L"{A65B8071-3BFE-4213-9A5B-491DA4461CA7}", &clsid);
CLSIDFromString(L"{9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2}", &iid);
CoInitialize(NULL);
IDxDiagProvider* pDxDiagProvider;
HRESULT hr = CoCreateInstance(clsid, NULL, 1, iid, (LPVOID*)&pDxDiagProvider); // S_OK
DXDIAG_INIT_PARAMS params;
params.dwSize = sizeof(DXDIAG_INIT_PARAMS);
params.dwDxDiagHeaderVersion = 111;
params.bAllowWHQLChecks = 0;
params.pReserved = 0;
// Sorry for the C-like access, I don't have anything better than the structs above.
hr = pDxDiagProvider->lpVtbl->Initialize(pDxDiagProvider, ¶ms); // S_OK
}
托管代码(损坏)
然后我继续将其移植到具有以下定义的 STAThread
x86 .NET 4.6.1 C# 控制台程序:
[ComImport]
[Guid("A65B8071-3BFE-4213-9A5B-491DA4461CA7")]
public class DxDiagProvider { }
[Guid("9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2")]
public interface IDxDiagProvider
{
void Initialize(ref DXDIAG_INIT_PARAMS pParams);
void GetRootContainer(ref IDxDiagContainer ppInstance);
}
[StructLayout(LayoutKind.Sequential)]
public struct DXDIAG_INIT_PARAMS
{
public uint dwSize;
public uint dwDxDiagHeaderVersion;
public bool bAllowWHQLChecks;
public IntPtr pReserved;
};
[Guid("7D0F462F-4064-4862-BC7F-933E5058C10F")]
public interface IDxDiagContainer
{
void EnumChildContainerNames(uint dwIndex, string pwszContainer, uint cchContainer);
void EnumPropNames(uint dwIndex, string pwszPropName, uint cchPropName);
void GetChildContainer(string pwszContainer, ref IDxDiagContainer ppInstance);
void GetNumberOfChildContainers(ref uint pdwCount);
void GetNumberOfProps(ref uint pdwCount);
void GetProp(string pwszPropName, ref IntPtr pvarProp);
}
现在,在创建 class 和转换接口时,对 Initialize
的调用中断 COMException: Exception from HRESULT: 0xFFFFFFFF
:
[STAThread]
static void Main(string[] args)
{
// Working fine.
DxDiagProvider dxDiagProviderClass = new DxDiagProvider();
IDxDiagProvider dxDiagProvider = (IDxDiagProvider)dxDiagProviderClass;
DXDIAG_INIT_PARAMS initParams = new DXDIAG_INIT_PARAMS
{
dwSize = (uint)Marshal.SizeOf<DXDIAG_INIT_PARAMS>(),
dwDxDiagHeaderVersion = 111
};
dxDiagProvider.Initialize(ref initParams); // causes COMException
}
我不确定我做错了什么。到目前为止,我已经测试并检查了以下内容:
- 确保
DXDIAG_INIT_PARAMS
结构的大小、对齐、布局正确 - 确保我的方法顺序正确并且我没有添加
IUnknown
方法 - 尝试将
DispIdAttribute
添加到接口方法中,尽管我认为这仅在托管 COM 对象而不使用它们时相关。 - 尝试将参数作为非引用传递,即使它们应该是
ref
因为参数是指针。
我真的希望这与 COM 对象在托管应用程序中使用时无法正常工作无关(这肯定会使这个问题过于宽泛)。所以我想至少确保我的方法和定义是正确的。是否还有其他必须完成但我遗漏的事情?
我发现我遗漏了什么并且可以修复它:
显然,我忘记用 InterfaceTypeAttribute
修饰 C# 接口并指定 ComInterfaceType.InterfaceIsIUnknown
。至少对于这些 COM 对象,这是必需的,因为默认 ComInterfaceType.InterfaceIsDual
会导致 COMException
被抛出。
例如,接口定义现在在 C# 中看起来像这样(另外我修复了一些 ref
到 out
参数,但是这不是这个问题的原因):
[Guid("9C6B4CB0-23F8-49CC-A3ED-45A55000A6D2")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] // <-- need this
public interface IDxDiagProvider
{
void Initialize(ref DXDIAG_INIT_PARAMS pParams);
void GetRootContainer(out IDxDiagContainer ppInstance);
}
[Guid("7D0F462F-4064-4862-BC7F-933E5058C10F")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] // <-- need this
public interface IDxDiagContainer
{
void EnumChildContainerNames(uint dwIndex, string pwszContainer, uint cchContainer);
void EnumPropNames(uint dwIndex, string pwszPropName, uint cchPropName);
void GetChildContainer(string pwszContainer, out IDxDiagContainer ppInstance);
void GetNumberOfChildContainers(out uint pdwCount);
void GetNumberOfProps(out uint pdwCount);
void GetProp(string pwszPropName, out IntPtr pvarProp);
}