C++ Programmer's Cookbook

• Download source - 5.21 Kb

Preface

COM Interoperability is the feature of Microsoft .NET that allows managed .NET code to interact with unmanaged code using Microsoft's Component Object Model semantics.

This article is geared towards C# programmers who are familiar with developing COM components and familiar with the concept of an interface. I'll review some background on COM, explain how C# interacts with COM, and then show how to design .NET components to smoothly interact with COM.

For those die-hard COM experts, there will be some things in this article that are oversimplified, but the concepts, as presented, are the important points to know for those developers supplementing their COM code with .NET components.

Introduction

.NET Interfaces and Classes

The basis for accessing .NET objects either from other .NET code or from unmanaged code is the Class. A .NET class represents the encapsulation of the functionality (methods and properties) that the programmer wants to expose to other code. A .NET interface is the abstract declaration of the methods and properties that classes which implement the interface are expected to provide in their implementations. Declaring a .NET interface doesn't generate any code, and a .NET interface is not callable directly. But any class which implements ("inherits") the interface must provide the code that implements each of the methods and properties declared in the interface definition.

Microsoft realized that the very first version of .NET needed a way to work with the existing Windows technology used to develop applications over the past 8+ years: COM. With that in mind, Microsoft added support in the .NET runtime for interoperating with COM - simply called "COM Interop". The support goes both ways: .NET code can call COM components, and COM code can call .NET components.

Using the code

Steps to create a Managed .NET C# COM Object:

1. Open VS.NET2003->New Project->Visual C# Projects->Class Library.
2. Project name: MyInterop.
3. Create MyDoNetClass.cs file, and add the following lines of code:

   using System.Runtime.InteropServices;
                   using System.Windows.Forms;

4. Create an Interface IMyDotNetInterface.
5. Create a class MyDoNetClass.
6. Add the following line for MyDotNetClass:

   [ClassInterface(ClassInterfaceType.None)]

Although a .NET class is not directly invokable from unmanaged code, Microsoft has provided the capability of wrapping a .NET interface in an unmanaged layer of code that exposes the methods and properties of the .NET class as if the class were a COM object. There are two requirements for making a .NET class visible to unmanaged code as a COM object:

Requirement 1:

You have to add GUIDs - Globally Unique Identifiers - into your code for the interface and the class separately, through a GUID tool.

7. Now, create a GUID for the Interface, and add the following line for the interface:

   [Guid("03AD5D2D-2AFD-439f-8713-A4EC0705B4D9")]

8. Now, create a GUID for the class, and add the following line for the class:

   [Guid("0490E147-F2D2-4909-A4B8-3533D2F264D0")]

9. Your code will look like:

   using System;
                   using System.Runtime.InteropServices;
                   using System.Windows.Forms;
                   namespace MyInterop
                   {
                   [Guid("03AD5D2D-2AFD-439f-8713-A4EC0705B4D9")]
                   interface IMyDotNetInterface
                   {
                   void ShowCOMDialog();
                   }
                   [ClassInterface(ClassInterfaceType.None)]
                   [Guid("0490E147-F2D2-4909-A4B8-3533D2F264D0")]
                   class MyDotNetClass : IMyDotNetInterface
                   {
                   // Need a public default constructor for COM Interop.
                   public MyDotNetClass()
                   {}
                   public void ShowCOMDialog()
                   {
                   System.Windows.Forms.MessageBox.Show(“I am a" +
                   "  Managed DotNET C# COM Object Dialog”);
                   }
                   }
                   }

10. Compile the solution.
11. You will see inside the project directory->obj->debug directory, the file “MyInterop.dll” generated after compilation.

Requirement 2:

Registration of the COM Class and Interfaces

For a COM class to be accessible by the client at runtime, the COM infrastructure must know how to locate the code that implements the COM class. COM doesn't know about .NET classes, but .NET provides a general "surrogate" DLL - mscoree.dll -- which acts as the wrapper and intermediary between the COM client and the .NET class.

12. Hard-code a specific version number in your AssemblyVersion attribute in the AssemblyInfo.cs file which is in your project.

    Example:

    [assembly: AssemblyVersion("1.0.0.0")]

13. Create a strong-name key pair for your assembly and point to it via the AssemblyKeyFile attribute in the AssemblyInfo.cs file which is in your project. Example:

    sn -k TestKeyPair.snk

    [assembly: AssemblyKeyFile("TestKeyPair.snk")]

14. Add your assembly to the GAC using the following command:

    gacutil /i MyInterop.dll

15. Register your assembly for COM by using the REGASM command along with the "/tlb" option to generate a COM type library.

    REGASM MyInterop.dll /tlb:com.MyInterop.tlb

16. Close the C# project.

Steps to create an Unmanaged C++ application to call a .NET Managed C# COM

1. Open VS.NET2003->New Project->Visual C++ Projects->Win32->Win32 Console Project.
2. Name: DotNet_COM_Call.
3. Include the following line in your DoNet_COM_Call.cpp file:

   #import “<Full Path>\com.MyInterop.tlb" named_guids raw_interfaces_only

4. Compile the solution.
5. It will generate a “com.myinterop.tlh” file into your project->debug directory.
6. You can open this file and see the contents. This is basically the proxy code of the C# COM code.
7. Now, you can write the code to call the .NET Managed COM.
8. Please add the following lines of code before calling the COM exported functions:

   CoInitialize(NULL);   //Initialize all COM Components
                   // <namespace>::<InterfaceName>
                   MyInterop::IMyDotNetInterfacePtr pDotNetCOMPtr;
                   // CreateInstance parameters
                   // e.g. CreateInstance (<namespace::CLSID_<ClassName>)
                   HRESULT hRes =
                   pDotNetCOMPtr.CreateInstance(MyInterop::CLSID_MyDotNetClass);
                   if (hRes == S_OK)
                   {
                   BSTR str;
                   pDotNetCOMPtr->ShowCOMDialog ();
                   //call .NET COM exported function ShowDialog ()
                   }
                   CoUninitialize ();   //DeInitialize all COM Components

9. Run this console application.
10. Expected result: a managed code (C# ) dialog should appear with the string “I am a Managed DotNET C# COM Object Dialog”.

Points of Interest

While creating an Interface for COM exported functions, creating GUIDs for the Interface and the class and registering the class are required steps, and doing all this is always interesting and fun. Calling parameterized exported functions also is very interesting.