如何：使用 WRL 创建传统型 COM 组件

项目
04/03/2023

除了用于通用 Windows 平台 (UWP) 应用程序，还可以使用 Windows 运行时 C++ 模板库 (WRL) 创建用于桌面应用程序的基本传统型 COM 组件。用于创建 COM 组件时，Windows 运行时 C++ 模板库需要的代码可能比 ATL 少。有关 Windows 运行时 C++ 模板库支持的 COM 子集的信息，请参阅 Windows 运行时 C++ 模板库 (WRL)。

本文档演示如何使用 Windows 运行时 C++ 模板库创建基本 COM 组件。尽管可以使用最适合你需求的部署机制，本文档还会展示一种从桌面应用程序注册及使用 COM 组件的基本方法。

使用 Windows 运行时 C++ 模板库创建基本传统型 COM 组件

在 Visual Studio 中，创建一个“空白解决方案”项目。为该项目命名，例如 WRLClassicCOM。
向该解决方案添加“Win32 项目”。为该项目命名，例如 CalculatorComponent。在“应用程序设置”选项卡上，选择“DLL”。
向该项目添加“Midl 文件(.idl)”文件。为该文件命名，例如，CalculatorComponent.idl。

将此代码添加到 CalculatorComponent.idl：

import "ocidl.idl";

[uuid(0DBABB94-CE99-42F7-ACBD-E698B2332C60), version(1.0)] 
interface ICalculatorComponent : IUnknown
{
    HRESULT Add([in] int a, [in] int b, [out, retval] int* value);
}

[uuid(9D3E6826-CB8E-4D86-8B14-89F0D7EFCD01), version(1.0)]
library CalculatorComponentLib
{
    [uuid(E68F5EDD-6257-4E72-A10B-4067ED8E85F2), version(1.0)]
    coclass CalculatorComponent
    {
        [default] interface ICalculatorComponent;
    }
};

在 CalculatorComponent.cpp 中，定义 CalculatorComponent 类。 CalculatorComponent 类继承自 Microsoft::WRL::RuntimeClass。 Microsoft::WRL::RuntimeClassFlags<ClassicCom> 指定类派生自 IUnknown 而不是 IInspectable。（IInspectable 仅适用于 Windows 运行时应用程序组件。）CoCreatableClass 为可与 CoCreateInstance 等函数一起使用的类创建一个工厂。

#include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier

#include "CalculatorComponent_h.h"
#include <wrl.h>

using namespace Microsoft::WRL;

class CalculatorComponent: public RuntimeClass<RuntimeClassFlags<ClassicCom>, ICalculatorComponent>
{
public:
    CalculatorComponent()
    {
    }

    STDMETHODIMP Add(_In_ int a, _In_ int b, _Out_ int* value)
    {
        *value = a + b;
        return S_OK;
    }
};

CoCreatableClass(CalculatorComponent);

用下面的代码替换 dllmain.cpp 中的代码。此文件定义 DLL 导出函数。这些函数使用 Microsoft::WRL::Module 类来管理模块的类工厂。

#include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier
#include <wrl\module.h>

using namespace Microsoft::WRL;

#if !defined(__WRL_CLASSIC_COM__)
STDAPI DllGetActivationFactory(_In_ HSTRING activatibleClassId, _COM_Outptr_ IActivationFactory** factory)
{
    return Module<InProc>::GetModule().GetActivationFactory(activatibleClassId, factory);
}
#endif

#if !defined(__WRL_WINRT_STRICT__)
STDAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, _COM_Outptr_ void** ppv)
{
    return Module<InProc>::GetModule().GetClassObject(rclsid, riid, ppv);
}
#endif

STDAPI DllCanUnloadNow()
{
    return Module<InProc>::GetModule().Terminate() ? S_OK : S_FALSE;
}

STDAPI_(BOOL) DllMain(_In_opt_ HINSTANCE hinst, DWORD reason, _In_opt_ void*)
{
    if (reason == DLL_PROCESS_ATTACH)
    {
        DisableThreadLibraryCalls(hinst);
    }
    return TRUE;
}

向该项目添加“模块定义文件 (.def)”文件。为该文件命名，例如，CalculatorComponent.def。此文件为链接器提供了要导出的函数的名称。打开项目的“属性页”对话框，然后在“配置属性”>“链接器”>“输入”下，将“模块定义文件”属性设置为 DEF 文件。

将此代码添加到 CalculatorComponent.def：

LIBRARY

EXPORTS
    DllGetActivationFactory PRIVATE
    DllGetClassObject       PRIVATE
    DllCanUnloadNow         PRIVATE

将 runtimeobject.lib 添加到链接器行。要了解如何添加，请参阅用作链接器输入的 .Lib 文件。

从桌面应用程序使用 COM 组件

向 Windows 注册表注册 COM 组件。若要实现此操作，请创建一个注册表项文件，将其命名为 RegScript.reg，并添加以下文本。将 <dll-path> 替换为 DLL 的路径，例如 C:\temp\WRLClassicCOM\Debug\CalculatorComponent.dll。

Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}]
@="CalculatorComponent Class"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\InprocServer32]
@="<dll-path>"
"ThreadingModel"="Apartment"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\Programmable]

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\TypeLib]
@="{9D3E6826-CB8E-4D86-8B14-89F0D7EFCD01}"

[HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{E68F5EDD-6257-4E72-A10B-4067ED8E85F2}\Version]
@="1.0"

运行 RegScript.reg 或将其添加到项目的生成后事件。有关详细信息，请参阅预生成事件/生成后事件命令行对话框。
向该解决方案添加“Win32 控制台应用程序”项目。为该项目命名，例如 Calculator。

用此代码替换 Calculator.cpp 的内容：

#include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier

#include "..\CalculatorComponent\CalculatorComponent_h.h"

const IID IID_ICalculatorComponent = {0x0DBABB94,0xCE99,0x42F7,0xAC,0xBD,0xE6,0x98,0xB2,0x33,0x2C,0x60};
const CLSID CLSID_CalculatorComponent = {0xE68F5EDD,0x6257,0x4E72,0xA1,0x0B,0x40,0x67,0xED,0x8E,0x85,0xF2};

// Prints an error string for the provided source code line and HRESULT
// value and returns the HRESULT value as an int.
int PrintError(unsigned int line, HRESULT hr)
{
    wprintf_s(L"ERROR: Line:%d HRESULT: 0x%X\n", line, hr);
    return hr;
}

int wmain()
{
    HRESULT hr;

    // Initialize the COM library.
    hr = CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    ICalculatorComponent* calc = nullptr; // Interface to COM component.

    // Create the CalculatorComponent object.
    hr = CoCreateInstance(CLSID_CalculatorComponent, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(&calc));
    if (SUCCEEDED(hr))
    {
        // Test the component by adding two numbers.
        int result;
        hr = calc->Add(4, 5, &result);
        if (FAILED(hr))
        {
            PrintError(__LINE__, hr);
        }
        else
        {
            wprintf_s(L"result = %d\n", result);
        }

        // Free the CalculatorComponent object.
        calc->Release();
    }
    else
    {
        // Object creation failed. Print a message.
        PrintError(__LINE__, hr);
    }

    // Free the COM library.
    CoUninitialize();

    return hr;
}
/* Output:
result = 9
*/

可靠编程

本文档使用标准 COM 函数来演示可使用 Windows 运行时 C++ 模板库来创建 COM 组件并使其可用于支持 COM 的任何技术。还可在桌面应用程序中使用 Windows 运行时 C++ 模板库类型（如 Microsoft::WRL::ComPtr）来管理 COM 及其他对象的生存期。以下代码使用 Windows 运行时 C++ 模板库来管理 ICalculatorComponent 指针的生存期。 CoInitializeWrapper 类是一种 RAII 包装，可保证 COM 库已释放，并保证 COM 库的生存期长于 ComPtr 智能指针对象。

#include "pch.h" // Use stdafx.h in Visual Studio 2017 and earlier
#include <wrl.h>

#include "..\CalculatorComponent\CalculatorComponent_h.h"

using namespace Microsoft::WRL;

const IID IID_ICalculatorComponent = {0x0DBABB94,0xCE99,0x42F7,0xAC,0xBD,0xE6,0x98,0xB2,0x33,0x2C,0x60};
const CLSID CLSID_CalculatorComponent = {0xE68F5EDD,0x6257,0x4E72,0xA1,0x0B,0x40,0x67,0xED,0x8E,0x85,0xF2};

// Prints an error string for the provided source code line and HRESULT
// value and returns the HRESULT value as an int.
int PrintError(unsigned int line, HRESULT hr)
{
    wprintf_s(L"ERROR: Line:%d HRESULT: 0x%X\n", line, hr);
    return hr;
}

int wmain()
{
    HRESULT hr;

    // RAII wrapper for managing the lifetime of the COM library.
    class CoInitializeWrapper
    {
        HRESULT _hr;
    public:
        CoInitializeWrapper(DWORD flags)
        {
            _hr = CoInitializeEx(nullptr, flags);
        }
        ~CoInitializeWrapper()
        {
            if (SUCCEEDED(_hr))
            {
                CoUninitialize();
            }
        }
        operator HRESULT()
        {
            return _hr;
        }

    };

    // Initialize the COM library.
    CoInitializeWrapper initialize(COINIT_APARTMENTTHREADED);
    if (FAILED(initialize))
    {
        return PrintError(__LINE__, initialize);
    }

    ComPtr<ICalculatorComponent> calc; // Interface to COM component.

    // Create the CalculatorComponent object.
    hr = CoCreateInstance(CLSID_CalculatorComponent, nullptr, CLSCTX_INPROC_SERVER, IID_PPV_ARGS(calc.GetAddressOf()));
    if (SUCCEEDED(hr))
    {
        // Test the component by adding two numbers.
        int result;
        hr = calc->Add(4, 5, &result);
        if (FAILED(hr))
        {
            return PrintError(__LINE__, hr);
        }
        wprintf_s(L"result = %d\n", result);
    }
    else
    {
        // Object creation failed. Print a message.
        return PrintError(__LINE__, hr);
    }

    return 0;
}

另请参阅

Windows 运行时 C++ 模板库 (WRL)

通过

如何：使用 WRL 创建传统型 COM 组件

使用 Windows 运行时 C++ 模板库创建基本传统型 COM 组件

从桌面应用程序使用 COM 组件

可靠编程

另请参阅

反馈

其他资源