Comment : créer un composant COM classique à l'aide de WRL

Article
06/09/2015

Vous pouvez utiliser Bibliothèque de modèles Windows Runtime C++ (WRL) pour créer les composants COM classiques de base pour une utilisation dans les applications de bureau, en plus de son utilisation pour les applications Windows Store. Pour la création de composants COM, WRL peut nécessiter moins de code que l'ATL. Pour plus d'informations sur le sous-ensemble COM pris en charge par WRL, consultez dans Bibliothèque de modèles Windows Runtime C++ (WRL).

Ce document montre comment utiliser WRL pour créer un composant COM de base. Bien que vous puissiez utiliser le mécanisme de déploiement qui correspond le mieux à vos besoins, ce document contient également une méthode de base pour stocker et utiliser le composant COM d'une application de bureau.

Montre comment utiliser WRL pour créer un composant COM de base.

Dans Visual Studio, créée un projet Blank Solution. Nommez le projet, par exemple, WRLClassicCOM.
Ajoutez un nouveau projet Win32 à la solution. Nommez le projet, par exemple, CalculatorComponent. Sous l'onglet Paramètres de l'application, sélectionnez DLL.
Ajoutez un fichier **Midl File (.idl)**au projet. Nommez le fichier, par exemple, CalculatorComponent.idl.

Ajoutez le code à 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;
    }
};

Dans CalculatorComponent.cpp, définissez la classe CalculatorComponent. La classe CalculatorComponent hérite deMicrosoft::WRL::RuntimeClass. Microsoft::WRL::RuntimeClassFlags<ClassicCom> indique que la classe provient de IUnknown et pas de IInspectable. (IInspectable est disponible uniquement pour les composants d'applications Store .) CoCreatableClass crée une fabrique pour la classe, qui peut etre utilisée avec des fonctions commeCoCreateInstance.
```
#include "stdafx.h"

#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);
```

Utilisez le code suivant pour remplacer le code dans dllmain.cpp. Ce fichier définit les fonctions d'exportation DLL. Ces fonctions utilisent la classe Microsoft::WRL::Module pour gérer les fabriques de classe pour le module.

#include "stdafx.h"
#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;
}

Ajoute un fichier Fichier de définition de module (.def) au projet. Nommez le fichier, par exemple, CalculatorComponent.def. Ce fichier donne à l'éditeur de liens les noms des fonctions qui doivent etre exportées.

Ajoutez ce code à CalculatorComponent.def :

LIBRARY

EXPORTS
    DllGetActivationFactory PRIVATE
    DllGetClassObject       PRIVATE
    DllCanUnloadNow         PRIVATE

Ajoutez runtimeobject.lib sur la ligne de l'éditeur de liens. Pour savoir comment, consultez .Fichiers .lib en tant qu'entrée de l'Éditeur de liens.

Pour utiliser le composant COM d'une application de bureau

Enregistrez le composant COM avec le Registre Windows. Pour cela, créez les entrées d'inscription fichier, appelez leRegScript.reg, puis ajoutez le texte suivant. Remplacez<dll-path> par le chemin d'accès de votre DLL- par exemple, 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"

Exécutez RegScript.reg ou ajoutez-le à l'Événement post-buildde votre projet. Pour plus d'informations, consultez Ligne de commande de l'événement pré-build/post-build, boîte de dialogue.
Ajoutez un projet Win32 Console Application à la solution. Nommez le projet, par exemple Calculator.

Utilisez ce code pour remplacer le contenu de Calculator.cpp :

#include "stdafx.h"

#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
*/

Programmation fiable

Ce document utilise des fonctions COM standard pour illustrer que vous pouvez utiliser WRL pour créer un composant COM et le rendre disponible à n'importe quelle technologie COM- activée. Vous pouvez également utiliser des types WRL comme Microsoft::WRL::ComPtr dans votre application de bureau pour gérer la durée de vie de COM et des autres objets. Le code ci-dessous utilise WRL pour gérer la durée de vie du pointeur d'ICalculatorComponent. La classe CoInitializeWrapper est un wrapper de RAII qui garantit que la bibliothèque COM est libérée et que la durée de vie de la bibliothèque COM est plus grande que celle de l'objet pointeur intelligent d'ComPtr.

#include "stdafx.h"
#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;
}

Voir aussi

Concepts

Bibliothèque de modèles Windows Runtime C++ (WRL)

Partager via