次の方法で共有


方法: WRL を使用して従来の COM コンポーネントを作成する

Windows ストア の apps で使用する以外にデスクトップ アプリケーションで使用するための基本的な従来の COM コンポーネントを作成するために Windows ランタイム C++ テンプレート ライブラリ (WRL) を使用できます。COM コンポーネントの作成については、WRL は、ATL よりも少ないコードを必要とする場合があります。WRL がサポートする COM のサブセットについての情報は、Windows ランタイム C++ テンプレート ライブラリ (WRL) を参照してください。

ここでは、基本的な COM コンポーネントの作成に WRL を使用する方法を示します。最も適したが、このドキュメントのニーズ、デスクトップ アプリケーションから COM コンポーネントを登録し、実装する基本的な方法を示す配置機構を使用できます。

WRL を基本的な従来の COM コンポーネントを作成する方法

  1. Visual Studio で、[空のソリューション] のプロジェクトを作成します。プロジェクト (たとえば、WRLClassicCOMを付けます。

  2. ソリューションに [Win32 プロジェクト] を追加します。プロジェクト (たとえば、CalculatorComponentを付けます。[アプリケーションの設定] のタブで、[ [DLL]

  3. プロジェクトに [MIDL ファイル (.idl)] ファイルを追加します。たとえば、ファイル、CalculatorComponent.idlを付けます。

  4. 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;
        }
    };
    
  5. CalculatorComponent.cpp では、CalculatorComponent のクラスを定義します。CalculatorComponent のクラスは Microsoft::WRL::RuntimeClassから継承します。Microsoft::WRL::RuntimeClassFlags<ClassicCom> はない IInspectableクラスがから IUnknown 派生することを指定します。(IInspectable は ストア アプリケーションのコンポーネントにのみ使用できます)。CoCreatableClass は、関数 CoCreateInstanceで使用できるクラスのファクトリを作成します。

    #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)
        {
            if (value == nullptr)
            {
                return E_POINTER;
            }
            *value = a + b;
            return S_OK;
        }
    };
    
    CoCreatableClass(CalculatorComponent);
    
  6. dllmain.cpp のコードを置き換えるには、次のコードを使用します。このファイルは、DLL のエクスポート関数を定義します。これらの関数は、モジュールのクラス ファクトリの管理に Microsoft::WRL::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;
    }
    
  7. プロジェクトに [モジュール定義ファイル (.def)] ファイルを追加します。たとえば、ファイル、CalculatorComponent.defを付けます。このファイルはリンカーにエクスポートされる関数の名前を付けます。

  8. CalculatorComponent.def に次のコードを追加します:

    LIBRARY
    
    EXPORTS
        DllGetActivationFactory PRIVATE
        DllGetClassObject       PRIVATE
        DllCanUnloadNow         PRIVATE
    
  9. リンカーの行に runtimeobject.lib を追加します。方法については、リンカー入力としての .lib ファイル を参照してください。

デスクトップ アプリケーションから COM コンポーネントを実行するには

  1. Windows レジストリで COM コンポーネントを登録します。そのためには、登録エントリ ファイルを作成し、RegScript.regを提示し、次のテキストを追加します。DLL 例のように、B: 15\\temp\\WRLClassicCOM\\Debug\\CalculatorComponent.dllのパスに置き換えます <dll-path>。

    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"
    
  2. RegScript.reg を実行するか、プロジェクトの [ビルド後のイベント] に追加します。詳細については、「[ビルド前に実行するコマンド ライン] / [ビルド後に実行するコマンド ライン] ダイアログ ボックス」を参照してください。

  3. ソリューションに [Win32 コンソール アプリケーション] のプロジェクトを追加します。プロジェクト (たとえば、[電卓]を付けます。

  4. 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_ICalculatorComponent, reinterpret_cast<void**>(&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 コンポーネントの作成は、COM 対応方法で使用できるようにするために WRL を使用できることを示すために標準の COM 関数を使用します。また、のデスクトップ アプリケーションで COM、およびそのほかのオブジェクトの有効期間を管理するために Microsoft::WRL::ComPtr などの WRL の型を使用できます。次のコードは ICalculatorComponent のポインターの有効期間を管理するために WRL を使用します。CoInitializeWrapper のクラスは、そのライブラリで COM ライブラリの有効期間は ComPtr のスマート ポインター オブジェクトを克服するという保証 COM または解放を確実に RAII ラッパーです。

#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_ICalculatorComponent, reinterpret_cast<void**>(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)