在桌面 apps 可以使用 Windows 运行时 C++ 模板库 (WRL) 除了使用此范围之外 Windows 应用商店 apps 的,创建基本的传统的 COM 组件使用。传递给 COM 组件的创建,WRL 比 ATL 可能需要较少的代码。有关 WRL 支持 COM 的信息的子集,请参见 Windows 运行时 C++ 模板库 (WRL)。
本文档演示如何使用 WRL 创建一个基本的 COM 组件。虽然可以使用最符合您的需求的部署结构,文档还演示一个基本的方式注册和使用从桌面 app 的 COM 组件。
使用 WRL 创建一个基本的传统的 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 到 应用商店 app 元素可用。) 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);
使用以下代码替换在 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; }
添加一 模块定义文件 (.def) 文件添加到项目中。将该文件命名为,例如,CalculatorComponent.def。提供链接器函数的名称将导出的此文件。
将此代码添加到 CalculatorComponent.def:
LIBRARY EXPORTS DllGetActivationFactory PRIVATE DllGetClassObject PRIVATE DllCanUnloadNow PRIVATE
添加 runtimeobject.lib 到链接器行。了解如何,请参见 用作链接器输入的 .Lib 文件。
使用从桌面 app 的 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.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 函数表明,可以使用 WRL 生成 COM 组件并使其可用于所有启用 COM 的技术。您的桌面 app 还可以使用 WRL 类型 (如 Microsoft::WRL::ComPtr 管理生存期 COM 和其他对象。下面的代码使用 WRL 管理 ICalculatorComponent 指针的生存期。CoInitializeWrapper 选件类是指的 RAII 包装 COM 库中并确保释放 COM 库的生存期活动得比 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_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;
}