Erstellen von COM-Komponenten mit C++/WinRT

Artikel
07/13/2023

C++/WinRT dient als Hilfe beim Erstellen von klassischen COM-Komponenten (Component Object Model) bzw. „Co-Klassen“, wie dies auch für Windows-Runtime-Klassen der Fall ist. In diesem Thema wird die Vorgehensweise gezeigt.

Das Standardverhalten von C++/WinRT bezüglich COM-Schnittstellen

Von der C++/WinRT-Vorlage winrt::implements werden die Laufzeitklassen und Aktivierungsfactorys direkt oder indirekt abgeleitet.

Standardmäßig ignoriert winrt::implements die klassischen COM-Schnittstellen. Daher schlägt jeder Aufruf von QueryInterface für klassische COM-Schnittstellen mit der Ausnahme E_NOINTERFACE fehl. Standardmäßig unterstützt winrt::implements nur C++/WinRT-Schnittstellen.

winrt::IUnknown ist eine C++/WinRT-Schnittstelle, daher unterstützt winrt::implements Schnittstellen, die auf winrt::IUnknown basieren.
winrt::implements unterstützt ::IUnknown selbst standardmäßig nicht.

Gleich werden Sie sehen, wie Sie die Fälle, die standardmäßig nicht unterstützt werden, überwinden. Zunächst aber ein Codebeispiel, um zu verdeutlichen, was standardmäßig passiert.

// Sample.idl
namespace MyProject 
{
    runtimeclass Sample
    {
        Sample();
        void DoWork();
    }
}

// Sample.h
#include "pch.h"
#include <shobjidl.h> // Needed only for this file.

namespace winrt::MyProject::implementation
{
    struct Sample : implements<Sample, IInitializeWithWindow>
    {
        IFACEMETHOD(Initialize)(HWND hwnd);
        void DoWork();
    }
}

Der folgende Clientcode verwendet die Sample-Klasse.

// Client.cpp
Sample sample; // Construct a Sample object via its projection.

// This next line doesn't compile yet.
sample.as<IInitializeWithWindow>()->Initialize(hwnd);

Aktivieren der klassischen COM-Unterstützung

Damit winrt::implements klassische COM-Schnittstellen unterstützt, muss lediglich die Headerdatei unknwn.h eingefügt werden, bevor C++/WinRT-Header eingeschlossen werden.

Dies kann explizit oder indirekt durch Einschließen einer weiteren Headerdatei, z. B. ole2.h, erfolgen. Ein empfohlenes Verfahren besteht darin, die Headerdatei wil\cppwinrt.h einzuschließen, die in den Windows Implementation Libraries (WIL) enthalten ist. Die Headerdatei wil\cppwinrt.h stellt nicht nur sicher, dass unknwn.h vor winrt/base.h enthalten ist, sondern sorgt auch dafür, dass die Ausnahmen und Fehlercodes von C++/WinRT und WIL von der jeweils anderen Komponente interpretiert werden können.

Sie können dann as<> für klassische COM-Schnittstellen verwenden, und der Code im obigen Beispiel wird kompiliert.

Hinweis

Wenn Sie im obigen Beispiel auch nach dem Aktivieren der klassischen COM-Unterstützung im Client (dem Code, der die Klasse verwendet) nicht auch die klassische COM-Unterstützung im Server (dem Code, der die Klasse implementiert) aktiviert haben, dann stürzt der Aufruf von as<> auf dem Client ab, weil das QI für IInitializeWithWindow fehlschlägt.

Eine lokale (nicht projizierte) Klasse

Eine lokale Klasse ist eine Klasse, die in derselben Kompilierungseinheit (App oder andere Binärdatei) sowohl implementiert als auch verwendet wird; es gibt also keine Projektion für sie.

Im folgenden finden Sie ein Beispiel für eine lokale Klasse, die nur klassische COM-Schnittstellen implementiert.

struct LocalObject :
    winrt::implements<LocalObject, IInitializeWithWindow>
{
    ...
};

Wenn Sie dieses Beispiel implementieren, aber nicht die klassische COM-Unterstützung aktivieren, schlägt der folgende Code fehl.

winrt::make<LocalObject>(); // error: ‘first_interface’: is not a member of ‘winrt::impl::interface_list<>’

Auch hier wird IInitializeWithWindow nicht als COM-Schnittstelle erkannt, sodass sie von C++/WinRT ignoriert wird. Im Fall des LocalObject-Beispiels hat das Ignorieren von COM-Schnittstellen zur Folge, dass LocalObject überhaupt keine Schnittstellen aufweist. Allerdings muss jede COM-Klasse mindestens eine Schnittstelle implementieren.

Ein einfaches Beispiel für eine COM-Komponente

Hier ist ein einfaches Beispiel für eine COM-Komponente, die in C++/WinRT geschrieben wurde. Dies ist eine vollständige Auflistung einer Minianwendung. Sie können also den Code testen, indem Sie ihn in die Dateien pch.h und main.cpp eines neuen Projekts vom Typ Windows-Konsolenanwendung (C++/WinRT) einfügen.

// pch.h
#pragma once
#include <unknwn.h>
#include <winrt/Windows.Foundation.h>

// main.cpp : Defines the entry point for the console application.
#include "pch.h"

struct __declspec(uuid("ddc36e02-18ac-47c4-ae17-d420eece2281")) IMyComInterface : ::IUnknown
{
    virtual HRESULT __stdcall Call() = 0;
};

using namespace winrt;
using namespace Windows::Foundation;

int main()
{
    winrt::init_apartment();

    struct MyCoclass : winrt::implements<MyCoclass, IPersist, IStringable, IMyComInterface>
    {
        HRESULT __stdcall Call() noexcept override
        {
            return S_OK;
        }

        HRESULT __stdcall GetClassID(CLSID* id) noexcept override
        {
            *id = IID_IPersist; // Doesn't matter what we return, for this example.
            return S_OK;
        }

        winrt::hstring ToString()
        {
            return L"MyCoclass as a string";
        }
    };

    auto mycoclass_instance{ winrt::make<MyCoclass>() };
    CLSID id{};
    winrt::check_hresult(mycoclass_instance->GetClassID(&id));
    winrt::check_hresult(mycoclass_instance.as<IMyComInterface>()->Call());
}

Weitere Informationen findest du auch unter Verwenden von COM-Komponenten mit C++/WinRT.

Ein realistischeres und interessanteres Beispiel

Im restlichen Teil dieses Themas wird Schritt für Schritt die Erstellung eines Konsolenanwendungsprojekts mit minimalem Umfang beschrieben, bei dem C++/WinRT zum Implementieren einer einfachen Co-Klasse (COM-Komponente oder COM-Klasse) und einer Klassenfactory genutzt wird. Anhand der Beispielanwendung wird verdeutlicht, wie du eine Popupbenachrichtigung mit einer Rückrufschaltfläche bereitstellst. Mit der Co-Klasse (über die die COM-Schnittstelle INotificationActivationCallback implementiert wird) kann die Anwendung gestartet und zurückgerufen werden, wenn der Benutzer in der Popupbenachrichtigung auf diese Schaltfläche klickt.

Weitere Hintergrundinformationen zum Featurebereich von Popupbenachrichtigungen findest du unter Senden einer lokalen Popupbenachrichtigung. Da aber in keinem Codebeispiel dieses Abschnitts der Dokumentation C++/WinRT genutzt wird, empfehlen wir dir, den in diesem Thema gezeigten Code zu verwenden.

Erstellen eines Projekts vom Typ „Windows-Konsolenanwendung“ (ToastAndCallback)

Erstelle zunächst ein neues Projekt in Microsoft Visual Studio. Erstelle ein Projekt vom Typ Windows-Konsolenanwendung (C++/WinRT), und gib ihm den Namen ToastAndCallback.

Öffne pch.h, und füge #include <unknwn.h> vor den Include-Elementen für C++/WinRT-Header hinzu. Hier ist das Ergebnis angegeben. Du kannst den Inhalt deiner Datei pch.h durch diese Auflistung ersetzen.

// pch.h
#pragma once
#include <unknwn.h>
#include <winrt/Windows.Foundation.h>

Öffne main.cpp, und entferne die using-Direktiven, die von der Projektvorlage generiert werden. Füge stattdessen den folgenden Code ein (damit die benötigten Bibliotheken, Header und Typnamen vorhanden sind). Hier ist das Ergebnis angegeben. Du kannst den Inhalt deiner Datei main.cpp durch diese Auflistung ersetzen. (Wir haben in der Liste unten auch den Code aus main entfernt, weil wir diese Funktion später noch ersetzen.)

// main.cpp : Defines the entry point for the console application.

#include "pch.h"

#pragma comment(lib, "advapi32")
#pragma comment(lib, "ole32")
#pragma comment(lib, "shell32")

#include <iomanip>
#include <iostream>
#include <notificationactivationcallback.h>
#include <propkey.h>
#include <propvarutil.h>
#include <shlobj.h>
#include <winrt/Windows.UI.Notifications.h>
#include <winrt/Windows.Data.Xml.Dom.h>

using namespace winrt;
using namespace Windows::Data::Xml::Dom;
using namespace Windows::UI::Notifications;

int main() { }

Das Projekt kann noch nicht erstellt werden. Nachdem wir das Hinzufügen des Codes abgeschlossen haben, erhältst du eine Aufforderung zum Erstellen und Ausführen.

Implementieren der Co-Klasse und Klassenfactory

In C++/WinRT implementierst du Co-Klassen und Klassenfactorys per Ableitung von der Basisstruktur winrt::implements. Füge direkt nach den drei oben angegebenen using-Direktiven (und vor main) diesen Code ein, um die COM-Aktivatorkomponente deiner Popupbenachrichtigung zu implementieren.

static constexpr GUID callback_guid // BAF2FA85-E121-4CC9-A942-CE335B6F917F
{
    0xBAF2FA85, 0xE121, 0x4CC9, {0xA9, 0x42, 0xCE, 0x33, 0x5B, 0x6F, 0x91, 0x7F}
};

std::wstring const this_app_name{ L"ToastAndCallback" };

struct callback : winrt::implements<callback, INotificationActivationCallback>
{
    HRESULT __stdcall Activate(
        LPCWSTR app,
        LPCWSTR args,
        [[maybe_unused]] NOTIFICATION_USER_INPUT_DATA const* data,
        [[maybe_unused]] ULONG count) noexcept final
    {
        try
        {
            std::wcout << this_app_name << L" has been called back from a notification." << std::endl;
            std::wcout << L"Value of the 'app' parameter is '" << app << L"'." << std::endl;
            std::wcout << L"Value of the 'args' parameter is '" << args << L"'." << std::endl;
            return S_OK;
        }
        catch (...)
        {
            return winrt::to_hresult();
        }
    }
};

struct callback_factory : implements<callback_factory, IClassFactory>
{
    HRESULT __stdcall CreateInstance(
        IUnknown* outer,
        GUID const& iid,
        void** result) noexcept final
    {
        *result = nullptr;

        if (outer)
        {
            return CLASS_E_NOAGGREGATION;
        }

        return make<callback>()->QueryInterface(iid, result);
    }

    HRESULT __stdcall LockServer(BOOL) noexcept final
    {
        return S_OK;
    }
};

Für die Implementierung der obigen Co-Klasse wird das gleiche Muster eingehalten, das in Erstellen von APIs mit C++/WinRT veranschaulicht wird. Du kannst also das gleiche Verfahren nutzen, um COM-Schnittstellen und Windows-Runtime-Schnittstellen zu implementieren. Die Features von COM-Komponenten und Windows-Runtime-Klassen werden über Schnittstellen verfügbar gemacht. Jede COM-Schnittstelle wird letztendlich von der IUnknown-Schnittstelle abgeleitet. Die Windows-Runtime basiert auf COM. Ein Unterscheidungsmerkmal ist, dass Windows-Runtime-Schnittstellen letztendlich von der IInspectable-Schnittstelle abgeleitet werden (und IInspectable von IUnknown).

In der Co-Klasse im obigen Code implementieren wir die INotificationActivationCallback::Activate-Methode. Dies ist die Funktion, die aufgerufen wird, wenn der Benutzer in einer Popupbenachrichtigung auf die Rückrufschaltfläche klickt. Bevor diese Funktion aufgerufen werden kann, muss eine Instanz der Co-Klasse erstellt werden. Dies ist Aufgabe der Funktion IClassFactory::CreateInstance.

Die Co-Klasse, die wir gerade implementiert haben, wird als COM-Aktivator für Benachrichtigungen bezeichnet und verfügt über eine Klassen-ID (CLSID) in Form des oben angegebenen callback_guid-Bezeichners (vom Typ GUID). Wir verwenden diesen Bezeichner später in Form einer Startmenüverknüpfung und eines Windows-Registrierungseintrags. Die CLSID des COM-Aktivators und der Pfad zum zugeordneten COM-Server (der Pfad zur ausführbaren Datei, die wir hier erstellen) stellen den Mechanismus dar, mit dem eine Popupbenachrichtigung die Information erhält, von welcher Klasse beim Klicken auf die Rückrufschaltfläche eine Instanz erstellt werden muss (ob im Info-Center auf die Benachrichtigung geklickt wird oder nicht).

Bewährte Methoden für die Implementierung von COM-Methoden

Die Verfahren für die Fehlerbehandlung und die Ressourcenverwaltung können Hand in Hand gehen. Die Verwendung von Ausnahmen anstelle von Fehlercodes ist bequemer und praktischer. Falls du die Programmiertechnik „Ressourcenbelegung ist Initialisierung“ (Resource Acquisition Is Initialization, RAII) verwendest, kannst du das explizite Überprüfen auf Fehlercodes und das anschließende Freigeben von Ressourcen vermeiden. Überprüfungen dieser Art verkomplizieren deinen Code unnötig, und es ergeben sich viele Stellen, an denen sich Fehler einschleichen können. Verwende stattdessen RAII und Throw/Catch-Ausnahmen (Auslösen/Abfangen). Bei dieser Vorgehensweise sind deine Ressourcenzuordnungen vor Ausnahmen geschützt, und dein Code bleibt einfach.

Du darfst allerdings nicht zulassen, dass Ausnahmen deine COM-Methodenimplementierungen umgehen. Dies kannst du sicherstellen, indem du den Spezifizierer noexcept in deinen COM-Methoden nutzt. Es ist kein Problem, wenn im Aufrufdiagramm deiner Methode Ausnahmen ausgelöst werden, solange diese behandelt werden, bevor deine Methode beendet wird. Wenn du noexcept verwendest und dann zulässt, dass eine Ausnahme deine Methode umgeht, wird deine Anwendung beendet.

Hinzufügen von Hilfstypen und -funktionen

In diesem Schritt fügen wir einige Hilfstypen und -funktionen hinzu, die vom restlichen Code genutzt werden. Füge also direkt vor main Folgendes hinzu:

struct prop_variant : PROPVARIANT
{
    prop_variant() noexcept : PROPVARIANT{}
    {
    }

    ~prop_variant() noexcept
    {
        clear();
    }

    void clear() noexcept
    {
        WINRT_VERIFY_(S_OK, ::PropVariantClear(this));
    }
};

struct registry_traits
{
    using type = HKEY;

    static void close(type value) noexcept
    {
        WINRT_VERIFY_(ERROR_SUCCESS, ::RegCloseKey(value));
    }

    static constexpr type invalid() noexcept
    {
        return nullptr;
    }
};

using registry_key = winrt::handle_type<registry_traits>;

std::wstring get_module_path()
{
    std::wstring path(100, L'?');
    uint32_t path_size{};
    DWORD actual_size{};

    do
    {
        path_size = static_cast<uint32_t>(path.size());
        actual_size = ::GetModuleFileName(nullptr, path.data(), path_size);

        if (actual_size + 1 > path_size)
        {
            path.resize(path_size * 2, L'?');
        }
    } while (actual_size + 1 > path_size);

    path.resize(actual_size);
    return path;
}

std::wstring get_shortcut_path()
{
    std::wstring format{ LR"(%ProgramData%\Microsoft\Windows\Start Menu\Programs\)" };
    format += (this_app_name + L".lnk");

    auto required{ ::ExpandEnvironmentStrings(format.c_str(), nullptr, 0) };
    std::wstring path(required - 1, L'?');
    ::ExpandEnvironmentStrings(format.c_str(), path.data(), required);
    return path;
}

Implementieren der restlichen Funktionen und der Einstiegspunktfunktion „wmain“

Lösche deine Funktion main, und füge stattdessen diese Codeauflistung ein, die Code zum Registrieren deiner Co-Klasse enthält. Anschließend wird ein Popup bereitgestellt, mit dem für deine Anwendung ein Rückruf durchgeführt werden kann.

void register_callback()
{
    DWORD registration{};

    winrt::check_hresult(::CoRegisterClassObject(
        callback_guid,
        make<callback_factory>().get(),
        CLSCTX_LOCAL_SERVER,
        REGCLS_SINGLEUSE,
        &registration));
}

void create_shortcut()
{
    auto link{ winrt::create_instance<IShellLink>(CLSID_ShellLink) };
    std::wstring module_path{ get_module_path() };
    winrt::check_hresult(link->SetPath(module_path.c_str()));

    auto store = link.as<IPropertyStore>();
    prop_variant value;
    winrt::check_hresult(::InitPropVariantFromString(this_app_name.c_str(), &value));
    winrt::check_hresult(store->SetValue(PKEY_AppUserModel_ID, value));
    value.clear();
    winrt::check_hresult(::InitPropVariantFromCLSID(callback_guid, &value));
    winrt::check_hresult(store->SetValue(PKEY_AppUserModel_ToastActivatorCLSID, value));

    auto file{ store.as<IPersistFile>() };
    std::wstring shortcut_path{ get_shortcut_path() };
    winrt::check_hresult(file->Save(shortcut_path.c_str(), TRUE));

    std::wcout << L"In " << shortcut_path << L", created a shortcut to " << module_path << std::endl;
}

void update_registry()
{
    std::wstring key_path{ LR"(SOFTWARE\Classes\CLSID\{????????-????-????-????-????????????})" };
    ::StringFromGUID2(callback_guid, key_path.data() + 23, 39);
    key_path += LR"(\LocalServer32)";
    registry_key key;

    winrt::check_win32(::RegCreateKeyEx(
        HKEY_CURRENT_USER,
        key_path.c_str(),
        0,
        nullptr,
        0,
        KEY_WRITE,
        nullptr,
        key.put(),
        nullptr));
    ::RegDeleteValue(key.get(), nullptr);

    std::wstring path{ get_module_path() };

    winrt::check_win32(::RegSetValueEx(
        key.get(),
        nullptr,
        0,
        REG_SZ,
        reinterpret_cast<BYTE const*>(path.c_str()),
        static_cast<uint32_t>((path.size() + 1) * sizeof(wchar_t))));

    std::wcout << L"In " << key_path << L", registered local server at " << path << std::endl;
}

void create_toast()
{
    XmlDocument xml;

    std::wstring toastPayload
    {
        LR"(
<toast>
  <visual>
    <binding template='ToastGeneric'>
      <text>)"
    };
    toastPayload += this_app_name;
    toastPayload += LR"(
      </text>
    </binding>
  </visual>
  <actions>
    <action content='Call back )";
    toastPayload += this_app_name;
    toastPayload += LR"(
' arguments='the_args' activationKind='Foreground' />
  </actions>
</toast>)";
    xml.LoadXml(toastPayload);

    ToastNotification toast{ xml };
    ToastNotifier notifier{ ToastNotificationManager::CreateToastNotifier(this_app_name) };
    notifier.Show(toast);
    ::Sleep(50); // Give the callback chance to display.
}

void LaunchedNormally(HANDLE, INPUT_RECORD &, DWORD &);
void LaunchedFromNotification(HANDLE, INPUT_RECORD &, DWORD &);

int wmain(int argc, wchar_t * argv[], wchar_t * /* envp */[])
{
    winrt::init_apartment();

    register_callback();

    HANDLE consoleHandle{ ::GetStdHandle(STD_INPUT_HANDLE) };
    INPUT_RECORD buffer{};
    DWORD events{};
    ::FlushConsoleInputBuffer(consoleHandle);

    if (argc == 1)
    {
        LaunchedNormally(consoleHandle, buffer, events);
    }
    else if (argc == 2 && wcscmp(argv[1], L"-Embedding") == 0)
    {
        LaunchedFromNotification(consoleHandle, buffer, events);
    }
}

void LaunchedNormally(HANDLE consoleHandle, INPUT_RECORD & buffer, DWORD & events)
{
    try
    {
        bool runningAsAdmin{ ::IsUserAnAdmin() == TRUE };
        std::wcout << this_app_name << L" is running" << (runningAsAdmin ? L" (administrator)." : L" (NOT as administrator).") << std::endl;

        if (runningAsAdmin)
        {
            create_shortcut();
            update_registry();
        }

        std::wcout << std::endl << L"Press 'T' to display a toast notification (press any other key to exit)." << std::endl;

        ::ReadConsoleInput(consoleHandle, &buffer, 1, &events);
        if (towupper(buffer.Event.KeyEvent.uChar.UnicodeChar) == L'T')
        {
            create_toast();
        }
    }
    catch (winrt::hresult_error const& e)
    {
        std::wcout << L"Error: " << e.message().c_str() << L" (" << std::hex << std::showbase << std::setw(8) << static_cast<uint32_t>(e.code()) << L")" << std::endl;
    }
}

void LaunchedFromNotification(HANDLE consoleHandle, INPUT_RECORD & buffer, DWORD & events)
{
    ::Sleep(50); // Give the callback chance to display its message.
    std::wcout << std::endl << L"Press any key to exit." << std::endl;
    ::ReadConsoleInput(consoleHandle, &buffer, 1, &events);
}

Testen der Beispielanwendung

Erstelle die Anwendung, und führe sie dann mindestens einmal als Administrator aus, damit Code für die Registrierung und andere Setupschritte ausgeführt wird. Eine Möglichkeit besteht hierbei darin, Visual Studio als Administrator und dann die App über Visual Studio auszuführen. Klicke in der Taskleiste mit der rechten Maustaste auf „Visual Studio“, um die Sprungliste anzuzeigen, klicke darin mit der rechten Maustaste auf „Visual Studio“, und klicke dann auf Als Administrator ausführen. Stimme in der Eingabeaufforderung zu, und öffne anschließend das Projekt. Wenn du die Anwendung ausführst, wird eine Meldung mit einem Hinweis angezeigt, ob die Anwendung als Administrator ausgeführt wird. Wenn nicht, können der Registrierungsvorgang und andere Setupschritte nicht ausgeführt werden. Der Registrierungsvorgang und die anderen Setupschritte müssen mindestens einmal erfolgen, damit die Anwendung richtig funktioniert.

Drücke unabhängig davon, ob du die Anwendung als Administrator ausführst, die Taste „T“, damit ein Popup angezeigt wird. Du kannst dann entweder direkt in der angezeigten Popupbenachrichtigung oder im Info-Center auf die Schaltfläche Call back ToastAndCallback (Rückruf ToastAndCallback) klicken. Deine Anwendung wird gestartet, die Co-Klasse wird instanziiert, und die INotificationActivationCallback::Activate-Methode wird ausgeführt.

In-Process-COM-Server

Die Beispiel-App ToastAndCallback dient als lokaler COM-Server („Out-of-Process“). Dies wird durch den Windows-Registrierungsschlüssel LocalServer32 angegeben, den du zum Registrieren der CLSID der zugehörigen Co-Klasse verwendest. Ein lokaler COM-Server hostet seine Co-Klassen in einer ausführbaren Binärdatei (.exe).

Alternativ kannst du auch die Entscheidung treffen, deine Co-Klassen in einer Dynamic Link Library (.dll) zu hosten (die wahrscheinlichere Vorgehensweise). Ein COM-Server in Form einer DLL wird als In-Process-COM-Server bezeichnet. Dies wird angegeben, indem CLSIDs über den Windows-Registrierungsschlüssel InprocServer32 registriert werden.

Erstellen eines DLL-Projekts (Dynamic Link Library)

Du kannst mit dem Erstellen eines In-Process-COM-Servers beginnen, indem du in Microsoft Visual Studio ein neues Projekt erstellst. Erstelle ein Projekt vom Typ Visual C++>Windows Desktop>Dynamic Link Library (DLL) .

Führe zum Hinzufügen von C++/WinRT-Unterstützung zum neuen Projekt die Schritte aus, die unter Ändern eines Windows Desktop-Anwendungsprojekts, um C++/WinRT-Unterstützung hinzuzufügen beschrieben sind.

Implementieren der Co-Klasse, Klassenfactory und In-Process-Serverexporte

Öffne dllmain.cpp, und füge der Datei die unten angegebene Codeauflistung hinzu.

Wenn du bereits über eine DLL verfügst, mit der C++/WinRT-Windows-Runtime-Klassen implementiert werden, ist die unten dargestellte Funktion DllCanUnloadNow bereits vorhanden. Falls du dieser DLL Co-Klassen hinzufügen möchtest, kannst du die Funktion DllGetClassObject hinzufügen.

Falls kein Code vom Typ Windows Runtime C++ Template Library (WRL) vorhanden ist, für den auf Kompatibilität geachtet werden muss, kannst du die WRL-Teile aus dem angezeigten Code entfernen.

// dllmain.cpp

struct MyCoclass : winrt::implements<MyCoclass, IPersist>
{
    HRESULT STDMETHODCALLTYPE GetClassID(CLSID* id) noexcept override
    {
        *id = IID_IPersist; // Doesn't matter what we return, for this example.
        return S_OK;
    }
};

struct __declspec(uuid("85d6672d-0606-4389-a50a-356ce7bded09"))
    MyCoclassFactory : winrt::implements<MyCoclassFactory, IClassFactory>
{
    HRESULT STDMETHODCALLTYPE CreateInstance(IUnknown *pUnkOuter, REFIID riid, void **ppvObject) noexcept override
    {
        try
        {
            return winrt::make<MyCoclass>()->QueryInterface(riid, ppvObject);
        }
        catch (...)
        {
            return winrt::to_hresult();
        }
    }

    HRESULT STDMETHODCALLTYPE LockServer(BOOL fLock) noexcept override
    {
        // ...
        return S_OK;
    }

    // ...
};

HRESULT __stdcall DllCanUnloadNow()
{
#ifdef _WRL_MODULE_H_
    if (!::Microsoft::WRL::Module<::Microsoft::WRL::InProc>::GetModule().Terminate())
    {
        return S_FALSE;
    }
#endif

    if (winrt::get_module_lock())
    {
        return S_FALSE;
    }

    winrt::clear_factory_cache();
    return S_OK;
}

HRESULT __stdcall DllGetClassObject(GUID const& clsid, GUID const& iid, void** result)
{
    try
    {
        *result = nullptr;

        if (clsid == __uuidof(MyCoclassFactory))
        {
            return winrt::make<MyCoclassFactory>()->QueryInterface(iid, result);
        }

#ifdef _WRL_MODULE_H_
        return ::Microsoft::WRL::Module<::Microsoft::WRL::InProc>::GetModule().GetClassObject(clsid, iid, result);
#else
        return winrt::hresult_class_not_available().to_abi();
#endif
    }
    catch (...)
    {
        return winrt::to_hresult();
    }
}

Unterstützung für schwache Verweise

Siehe auch Schwache Verweise in C++/WinRT.

Unter C++/WinRT (über die Basisstrukturvorlage winrt::implements) wird IWeakReferenceSource für dich implementiert, wenn dein Typ IInspectable implementiert (oder eine andere Schnittstelle, die von IInspectable abgeleitet ist).

Der Grund ist, dass IWeakReferenceSource und IWeakReference für Windows-Runtime-Typen entworfen wurden. Du kannst die Unterstützung für schwache Verweise also für deine Co-Klasse aktivieren, indem du deiner Implementierung einfach winrt::Windows::Foundation::IInspectable hinzufügst (oder eine Schnittstelle, die von IInspectable abgeleitet ist).

struct MyCoclass : winrt::implements<MyCoclass, IMyComInterface, winrt::Windows::Foundation::IInspectable>
{
    //  ...
};

Implementieren einer COM-Schnittstelle, die von einer anderen Schnittstelle abgeleitet wird

Die Schnittstellenableitung ist ein Feature des klassischen COM (und es ist absichtlich nicht in der Windows-Runtime enthalten). Hier ist ein Beispiel dafür, wie eine Schnittstellenableitung aussieht.

IFileSystemBindData2 : public IFileSystemBindData { /* ... */  };

Wenn Sie eine Klasse schreiben, die z. B. sowohl IFileSystemBindData als auch IFileSystemBindData2 implementieren muss, dann besteht der erste Schritt, dies auszudrücken, darin, zu deklarieren, dass Sie nur die abgeleitete Schnittstelle implementieren, wie folgt.

// pch.h
#pragma once
#include <Shobjidl.h>
...

// main.cpp
...
struct MyFileSystemBindData :
    implements<MyFileSystemBindData,
    IFileSystemBindData2>
{
    // IFileSystemBindData
    IFACEMETHOD(SetFindData)(const WIN32_FIND_DATAW* pfd) override { /* ... */ return S_OK; };
    IFACEMETHOD(GetFindData)(WIN32_FIND_DATAW* pfd) override { /* ... */ return S_OK; };

    // IFileSystemBindData2
    IFACEMETHOD(SetFileID)(LARGE_INTEGER liFileID) override { /* ... */ return S_OK; };
    IFACEMETHOD(GetFileID)(LARGE_INTEGER* pliFileID) override { /* ... */ return S_OK; };
    IFACEMETHOD(SetJunctionCLSID)(REFCLSID clsid) override { /* ... */ return S_OK; };
    IFACEMETHOD(GetJunctionCLSID)(CLSID* pclsid) override { /* ... */ return S_OK; };
};
...
int main()
...

Der nächste Schritt besteht darin, sicherzustellen, dass QueryInterface erfolgreich ist, wenn es (direkt oder indirekt) für IID_IFileSystemBindData (die Basisschnittstelle) für eine Instanz von MyFileSystemBindData aufgerufen wird. Dazu stellen Sie eine Spezialisierung für die Funktionsvorlage winrt::is_guid_of bereit.

winrt::is_guid_of ist eine Variadic-Funktion, sodass Sie eine Liste von Schnittstellen zur Verfügung stellen können. Sie würden eine Spezialisierung folgendermaßen bereitstellen, damit eine Prüfung auf IFileSystemBindData2 auch einen Test aufIFileSystemBindData enthält.

// pch.h
...
namespace winrt
{
    template<>
    inline bool is_guid_of<IFileSystemBindData2>(guid const& id) noexcept
    {
        return is_guid_of<IFileSystemBindData2, IFileSystemBindData>(id);
    }
}

// main.cpp
...
int main()
{
    ...
    auto mfsbd{ winrt::make<MyFileSystemBindData>() };
    auto a{ mfsbd.as<IFileSystemBindData2>() }; // Would succeed even without the **is_guid_of** specialization.
    auto b{ mfsbd.as<IFileSystemBindData>() }; // Needs the **is_guid_of** specialization in order to succeed.
}

Die Spezialisierung von winrt::is_guid_of muss für alle Dateien im Projekt identisch und an dem Punkt sichtbar sein, an dem die Schnittstelle von der Vorlage winrt::implements oder winrt::delegate verwendet wird. In der Regel würden Sie sie in einer allgemeinen Headerdatei speichern.

Freigeben über

Erstellen von COM-Komponenten mit C++/WinRT

Das Standardverhalten von C++/WinRT bezüglich COM-Schnittstellen

Aktivieren der klassischen COM-Unterstützung

Eine lokale (nicht projizierte) Klasse

Ein einfaches Beispiel für eine COM-Komponente

Ein realistischeres und interessanteres Beispiel

Erstellen eines Projekts vom Typ „Windows-Konsolenanwendung“ (ToastAndCallback)

Implementieren der Co-Klasse und Klassenfactory

Bewährte Methoden für die Implementierung von COM-Methoden

Hinzufügen von Hilfstypen und -funktionen

Implementieren der restlichen Funktionen und der Einstiegspunktfunktion „wmain“

Testen der Beispielanwendung

In-Process-COM-Server

Erstellen eines DLL-Projekts (Dynamic Link Library)

Implementieren der Co-Klasse, Klassenfactory und In-Process-Serverexporte

Unterstützung für schwache Verweise

Implementieren einer COM-Schnittstelle, die von einer anderen Schnittstelle abgeleitet wird

Wichtige APIs

Feedback

Zusätzliche Ressourcen

Freigeben über

Erstellen von COM-Komponenten mit C++/WinRT

Das Standardverhalten von C++/WinRT bezüglich COM-Schnittstellen

Aktivieren der klassischen COM-Unterstützung

Eine lokale (nicht projizierte) Klasse

Ein einfaches Beispiel für eine COM-Komponente

Ein realistischeres und interessanteres Beispiel

Erstellen eines Projekts vom Typ „Windows-Konsolenanwendung“ (ToastAndCallback)

Implementieren der Co-Klasse und Klassenfactory

Bewährte Methoden für die Implementierung von COM-Methoden

Hinzufügen von Hilfstypen und -funktionen

Implementieren der restlichen Funktionen und der Einstiegspunktfunktion „wmain“

Testen der Beispielanwendung

In-Process-COM-Server

Erstellen eines DLL-Projekts (Dynamic Link Library)

Implementieren der Co-Klasse, Klassenfactory und In-Process-Serverexporte

Unterstützung für schwache Verweise

Implementieren einer COM-Schnittstelle, die von einer anderen Schnittstelle abgeleitet wird

Wichtige APIs

Zugehörige Themen

Feedback

Zusätzliche Ressourcen