将一个简单的C#DLL转换为COM互操作组件

Ele*_*nce 65 .net c# com interop com-interop

如何将C#DLL转换为可由VB6应用程序使用的COM互操作DLL?

Kie*_*one 87

这是我想在StackOverflow中找到但不能的答案.事实证明将一个简单的C#dll转换为COM dll相当容易.

创建C#dll

使用C#类项目创建解决方案.该类应具有属性/方法的接口和事件的接口.如MSDN - 示例COM类(C#编程指南)中所述,将GUID属性分配给类和接口.另请参阅:MSDN - 如何:提升COM接收器处理的事件.

在项目属性>应用程序选项卡>装配信息按钮>中,选中"使装配COM可见".这使得类COM中的所有公共方法都可见.

在项目属性>构建选项卡>将"平台目标"设置为x86.

这就是创建DLL所需要做的一切.要调用DLL,您需要注册它.

在开发计算机上注册DLL

您可以通过以下方式之一注册DLL:

  • 检查项目属性>构建选项卡>"注册COM Interop".这将在您构建DLL时自动注册DLL.
  • 使用RegAsm手动注册DLL.这允许您在您选择的目录中注册DLL,而不是在构建目录中.这是我使用的方法.

    • 不要检查项目属性>构建选项卡>"注册COM Interop"
    • 将DLL复制到要注册它的目录
    • 使用管理员权限和类型打开命令shell

      RegAsm.exe -tlb -codebase mydll.dll
      
      Run Code Online (Sandbox Code Playgroud)

      RegAsm.exe可以在"C:\ Windows\Microsoft.NET\Framework\v2.0.50727"中找到,而"mydll.dll"是您的DLL的名称; tlb意思是"创建一个类型库"; codebase表示"将目录位置写入注册表,假设它没有放在GAC中".

      RegAsm将显示一个警告,表示程序集应该是强名称的.你可以忽略它.

      此时,您应该能够在VB6中添加对COM DLL的引用,使用Intellisense查看它,并像常规COM DLL一样运行它.

使用InstallShield安装DLL

如果您使用InstallShield将DLL与应用程序的其余部分一起安装,请执行以下操作.

在InstallShield中,将新组件添加到"组件"列表中.请记住将Component与Feature关联.将组件属性".NET COM Interop"设置为Yes.

将.dll文件添加到Component的Files部分.不要检查"自注册"属性.右键单击.dll文件,然后选择"设置密钥文件".

将.tlb文件添加到Component的Files部分.检查"自注册"属性.

目标PC上需要存在正确版本的.Net Framework.

而已.


Mat*_*ius 11

作为@Kieren Johnstone 回答的扩展,你需要做一个关于类修改的实际代码示例:

从:

public class ApiCaller 
{

    public DellAsset GetDellAsset(string serviceTag, string apiKey)
    {
     ....
    }
}

public class DellAsset
{
    public string CountryLookupCode { get; set; }
    public string CustomerNumber { get; set; }
    public bool IsDuplicate { get; set; }
    public string ItemClassCode { get; set; }
    public string LocalChannel { get; set; }
    public string MachineDescription { get; set; }
    public string OrderNumber { get; set; }
    public string ParentServiceTag { get; set; }
    public string ServiceTag { get; set; }
    public string ShipDate { get; set; }

}
Run Code Online (Sandbox Code Playgroud)

到:

[Guid("EAA4976A-45C3-4BC5-BC0B-E474F4C3C83F")]
[ComVisible(true)]
public interface IComClassApiCaller
{
    IComClassDellAsset GetDellAsset(string serviceTag, string apiKey);

}

[Guid("7BD20046-DF8C-44A6-8F6B-687FAA26FA71"),
InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface IComClassApiCallerEvents
{
}

[Guid("0D53A3E8-E51A-49C7-944E-E72A2064F938"),
    ClassInterface(ClassInterfaceType.None),
    ComSourceInterfaces(typeof(IComClassApiCallerEvents))]
[ComVisible(true)]
[ProgId("ProgId.ApiCaller")]
public class ApiCaller : IComClassApiCaller {

    public IComClassDellAsset GetDellAsset(string serviceTag, string apiKey)
    {
        .....
    }
}


[Guid("EAA4976A-45C3-4BC5-BC0B-E474F4C3C83E")]
[ComVisible(true)]
public interface IComClassDellAsset
{
     string CountryLookupCode { get; set; }
     string CustomerNumber { get; set; }
     bool IsDuplicate { get; set; }
     string ItemClassCode { get; set; }
     string LocalChannel { get; set; }
     string MachineDescription { get; set; }
     string OrderNumber { get; set; }
     string ParentServiceTag { get; set; }
     string ServiceTag { get; set; }
     string ShipDate { get; set; }

}

[Guid("7BD20046-DF8C-44A6-8F6B-687FAA26FA70"),
InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface IComClassDellAssetEvents
{
}

[Guid("0D53A3E8-E51A-49C7-944E-E72A2064F937"),
    ClassInterface(ClassInterfaceType.None),
    ComSourceInterfaces(typeof(IComClassDellAssetEvents))]
[ComVisible(true)]
[ProgId("ProgId.DellAsset")]
public class DellAsset : IComClassDellAsset
{
    public string CountryLookupCode { get; set; }
    public string CustomerNumber { get; set; }
    public bool IsDuplicate { get; set; }
    public string ItemClassCode { get; set; }
    public string LocalChannel { get; set; }
    public string MachineDescription { get; set; }
    public string OrderNumber { get; set; }
    public string ParentServiceTag { get; set; }
    public string ServiceTag { get; set; }
    public string ShipDate { get; set; }

}
Run Code Online (Sandbox Code Playgroud)

希望这可以为您节省一些时间


Die*_*ten 6

互联网上的COM服务器的大多数例子都只包含一个CoClass,并且声称这个CoClass必须有一个公共构造函数。在这种情况下确实如此,但普通服务器有多个 CoClass,其中只能创建一个,而不可创建的 CoClass 的实例是可创建的 CoClass 的属性。例如,考虑与可创建的CoClass Word对象模型Application具有Documents这又由伴生类实例的属性Document。以下服务器有两个 CoClass,一个带有公共构造函数,另一个带有私有构造函数。

  1. 为 C# 类库 (.Net Framework) 而不是类库 (.Net Standard) 创建一个解决方案,并将其命名为例如 BankServerCSharp。明智地选择此名称,因为它将是 CoClass 的 ProgID 的主要部分和 C++ 中的命名空间名称。此名称也将列在 C# 和 VBA 的“引用”对话框中。

  2. 删除样板代码并添加两个文件 Bank.cs 和 Account.cs。插入以下代码:

    //Account.cs
    using System.Runtime.InteropServices;
    
    namespace BankServerCSharp
    {
      [ComVisible(true)]  // This is mandatory.
      [InterfaceType(ComInterfaceType.InterfaceIsDual)]
      public interface IAccount
      {
        double Balance { get; } // A property
        void Deposit(double b); // A method
      }
    
      [ComVisible(true)]  // This is mandatory.
      [ClassInterface(ClassInterfaceType.None)]
      public class Account:IAccount
      {
        private  double mBalance = 0;
        private Account() { }     // private constructor, coclass noncreatable
    
        public static Account MakeAccount() { return new Account(); }
        //MakeAccount is not exposed to COM, but can be used by other classes
    
        public double Balance  { get {  return mBalance; } }
        public void Deposit(double b) { mBalance += b; }
      }
    }
    
    //Bank.cs
    using System.Runtime.InteropServices;
    
    namespace BankServerCSharp
    {
      [ComVisible(true)]  // This is mandatory.
      [InterfaceType(ComInterfaceType.InterfaceIsDual)]
      public interface IBank
      {
        string BankName  {  get;  set;  }      // A property
        IAccount FirstAccount { get; }         // Another one of type IDispatch
      }
    
      [ComVisible(true)]  // This is mandatory.
      [ClassInterface(ClassInterfaceType.None)]
      public class Bank:IBank
      {
        private string Name = "";
        private readonly Account First;
    
        public Bank() { First = Account.MakeAccount(); }
    
        public string BankName  {
          get {   return Name; }
          set {   Name= value; }
        }
    
        public IAccount FirstAccount  {
          get { return First; }
        }
      }
    }
    
    Run Code Online (Sandbox Code Playgroud)
  3. 使用配置 Release/Any CPU 构建项目。输出是位于 \bin\release 文件夹中的托管 DLL BankServerCSharp.dll。

  4. 现在您必须注册您的托管 COM DLL。不要尝试 regsvr32,有一个名为 regasm 的特殊程序用于托管 COM DLL。Regasm 有一个适用于 32 位和 64 位应用程序的版本。以管理员身份打开命令提示符并更改为 C:\Windows\Microsoft.NET\Framework\v4.0.30319。此文件夹包含 regasm.exe 应用程序,用于注册托管 COM DLL,就像它是本机 32 位 COM DLL 一样。

  5. 键入RegAsm.exe /tlb /codebase path_to_your_bin_release_folder\BankServerCSharp.dll您必须以这种方式在任何计算机上注册您的 DLL。不要忘记创建类型库的 /tlb 开关。编译器会用一些你可以忽略的警告来注释开关 /codebase。DLL 在注册表的 WoW64 部分注册,可供本机(非托管)32 位应用程序使用。

  6. 现在重复注册以供 64 位应用程序使用托管 COM DLL。更改为 C:\Windows\Microsoft.NET\Framework 64 \v4.0.30319 并键入与之前相同的命令。

  7. 您可以通过以管理权限运行 Visual Studio并添加以下构建后事件来加快在您自己的 PC上的注册速度:

    %SystemRoot%\Microsoft.NET\Framework\v4.0.30319\RegAsm.exe /tlb /codebase "$(TargetPath)"
    %SystemRoot%\Microsoft.NET\Framework64\v4.0.30319\RegAsm.exe /tlb /codebase "$(TargetPath)"
    
    Run Code Online (Sandbox Code Playgroud)

您现在可以像使用本机非托管 COM DLL 一样使用您的 DLL。使用 VBA 测试您的 DLL:在工具/参考下勾选 BankServerCSharp。如果未显示,则注册失败。一个简单的测试子:

Sub TestSOExampleNew()
 On Error GoTo Oops

   Dim BiBiBaBa As New BankServerCSharp.Bank 'New!
   BiBiBaBa.BankName = "Big Bird Bad Bank"
   Dim Account As BankServerCSharp.Account   'No New!
   Set Account = BiBiBaBa.FirstAccount
   Account.Deposit 2000
   MsgBox BiBiBaBa.BankName & ". First client's balance: " & Account.Balance

   Exit Sub

 Oops:
   MsgBox "Sorry, an unexpected error occurred!"
End Sub
Run Code Online (Sandbox Code Playgroud)

要在 C++ 中测试托管 COM DLL,请创建一个新的控制台应用程序,插入以下代码并构建为 Release/x64 或 Release/x86:

#include "stdafx.h"
#import "D:\Aktuell\CSharpProjects\BankServerCSharp\BankServerCSharp\bin\Release\BankServerCSharp.tlb"
//this is the path of my C# project's bin\Release folder

inline void TESTHR(HRESULT x) { if FAILED(x) _com_issue_error(x); };

int main()
{
  try
  {
    TESTHR(CoInitialize(0));
    BankServerCSharp::IBankPtr BankPtr = nullptr;
    TESTHR(BankPtr.CreateInstance("BankServerCSharp.Bank"));
    BankPtr->BankName = L"Ernie First Global Bank";
    BankServerCSharp::IAccountPtr AccountPtr = BankPtr->FirstAccount;
    TESTHR(AccountPtr->Deposit(200.09));
    wprintf(L"Name: %s, Balance: %.2f\n", (LPCWSTR)BankPtr->BankName, AccountPtr->Balance);
  }
  catch (const _com_error& e)
  {
    CStringW out;
    out.Format(L"Exception occurred. HR = %lx, error = %s", e.Error(), e.ErrorMessage());
    MessageBoxW(NULL, out, L"Error", MB_OK);
  }

  CoUninitialize();// Uninitialize COM
  return 0;
}
Run Code Online (Sandbox Code Playgroud)