Como criar um componente COM clássico com WRL

Artigo
04/03/2023

Você pode usar a WRL (Biblioteca de Modelos C++ do Windows Runtime) para criar componentes COM clássicos básicos para uso em aplicativos da área de trabalho, além de usá-lo para aplicativos da UWP (Plataforma Universal do Windows). Para a criação de componentes COM, a Biblioteca de Modelos C++ do Windows Runtime pode exigir menos código do que a ATL. Para obter informações sobre o subconjunto de COM compatível com a Biblioteca de Modelos C++ do Windows Runtime, confira WRL (Biblioteca de Modelos C++ do Windows Runtime).

Este documento mostra como usar a Biblioteca de Modelos C++ do Windows Runtime para criar um componente COM básico. Embora você possa usar o mecanismo de implantação que melhor atenda às suas necessidades, este documento também mostra um modo básico de registrar e consumir o componente COM de um aplicativo da área de trabalho.

Usar a Biblioteca de Modelos C++ do Windows Runtime para criar um componente COM clássico básico

No Visual Studio, crie um projeto Solução em Branco. Nomeie o projeto, por exemplo, WRLClassicCOM.
Adicione um Projeto Win32 à solução. Nomeie o projeto, por exemplo, CalculatorComponent. Na guia Configurações de Aplicativo, selecione DLL.
Adicione um arquivo Midl (.idl) ao projeto. Nomeie o arquivo, por exemplo, CalculatorComponent.idl.

Adicione este código a 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;
    }
};

Em CalculatorComponent.cpp, defina a classe CalculatorComponent. A classe CalculatorComponent herda de Microsoft::WRL::RuntimeClass. Microsoft::WRL::RuntimeClassFlags<ClassicCom> especifica que a classe deriva de IUnknown e não de IInspectable. (IInspectable está disponível apenas para componentes do aplicativo Windows Runtime). CoCreatableClass cria uma fábrica para a classe que pode ser usada com funções como 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);

Use o código a seguir para substituir o código em dllmain.cpp. Esse arquivo define as funções de exportação de DLL. Essas funções usam a classe Microsoft::WRL::Module para gerenciar as fábricas de classes do módulo.

#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;
}

Adicione um arquivo de definição de módulo (.def) ao projeto. Nomeie o arquivo, por exemplo, CalculatorComponent.def. Esse arquivo fornece ao vinculador os nomes das funções a serem exportadas. Abra a caixa de diálogo Páginas de Propriedades do seu projeto e, em Propriedades de Configuração>Vinculador>Entrada defina a propriedade Arquivo de Definição de Módulo para o arquivo DEF.

Adicione este código a CalculatorComponent.def:

LIBRARY

EXPORTS
    DllGetActivationFactory PRIVATE
    DllGetClassObject       PRIVATE
    DllCanUnloadNow         PRIVATE

Adicione runtimeobject.lib à linha do vinculador. Para saber como, confira Arquivos .Lib como Entrada do Vinculador.

Consumir o componente COM de um aplicativo da área de trabalho

Registre o componente COM com o Registro do Windows. Para fazer isso, crie um arquivo de entradas de registro, nomeie-o como RegScript.reg e adicione o texto a seguir. Substitua <dll-path> pelo caminho de sua DLL, por exemplo, 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"

Execute RegScript.reg ou adicione-o ao Evento de Pós-Compilação do seu projeto. Para obter mais informações, confira a caixa de diálogo Linha de comando do evento de pós-build/pré-build.
Adicione um projeto Aplicativo de Console do Win32 à solução. Nomeie o projeto, por exemplo, Calculator.

Use este código para substituir o conteúdo de 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
*/

Programação robusta

Este documento usa funções COM padrão para demonstrar que você pode usar a biblioteca de Modelos C++ do Windows Runtime para criar um componente COM e disponibilizá-lo para qualquer tecnologia habilitada para COM. Você também pode usar os tipos de Biblioteca de Modelos C++ do Windows Runtime, como Microsoft::WRL::ComPtr em seu aplicativo da área de trabalho, para gerenciar o tempo de vida de COM e outros objetos. O código a seguir usa a Biblioteca de Modelos C++ do Windows Runtime para gerenciar o tempo de vida do ponteiro ICalculatorComponent. A classe CoInitializeWrapper é um wrapper RAII que garante que a biblioteca COM seja liberada e também garante que o tempo de vida da biblioteca COM sobreviva ao objeto de ponteiro inteligente 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;
}

Confira também

WRL (Biblioteca de Modelos C++ do Tempo de Execução do Windows)

Partilhar via

Como criar um componente COM clássico com WRL

Usar a Biblioteca de Modelos C++ do Windows Runtime para criar um componente COM clássico básico

Consumir o componente COM de um aplicativo da área de trabalho

Programação robusta

Confira também

Comentários

Recursos adicionais