Практическое руководство. Обработка событий с использованием WRL

Статья
02/20/2013

Это руководство показывает, как использовать Библиотека шаблонов C++ среды выполнения Windows (WRL) для подписки на события и обработка объекта Среда выполнения Windows.

Для более базового примера, который создает экземпляр этого компонента и получает значение свойства см. в разделе Практическое руководство. Активация и использование компонента среды выполнения Windows с помощью WRL.

Подписывание и обработки событий

Следующие шаги от объекта ABI::Windows::System::Threading::IDeviceWatcher и обработчики событий использования к монитору ".Интерфейс IDeviceWatcher позволяет указать устройства асинхронно, или в фоновом режиме и получает уведомление при добавлении, удалении или изменении устройства.Функция Обратный вызов является важной частью этого примера, поскольку она позволяет ему определить обработчики событий этот процесс результаты фоновой операции.Полный пример кода выглядит следующим образом.

Внимание
Хотя обычно используется WRL в приложении Магазина Windows, в этом образце используется приложение консоли для иллюстрации.Функции, такие как wprintf_s, не доступны из приложения Магазина Windows.Дополнительные сведения о типах и функциях, которые можно использовать в приложении Магазина Windows см. в разделе Функции CRT не поддерживаются при /ZW и Win32 и модели COM для приложений Windows Магазина.

Хотя обычно используется WRL в приложении Магазина Windows, в этом образце используется приложение консоли для иллюстрации.Функции, такие как wprintf_s, не доступны из приложения Магазина Windows.Дополнительные сведения о типах и функциях, которые можно использовать в приложении Магазина Windows см. в разделе Функции CRT не поддерживаются при /ZW и Win32 и модели COM для приложений Windows Магазина.

Включите (#include) все необходимое Среда выполнения Windows, WRL или стандартные заголовки библиотеки времени выполнения C и C-++.
```
#include <Windows.Devices.Enumeration.h>
#include <wrl/event.h>
#include <stdio.h>

using namespace ABI::Windows::Devices::Enumeration;
using namespace ABI::Windows::Foundation;
using namespace Microsoft::WRL;
using namespace Microsoft::WRL::Wrappers;
```
Windows.Devices.Enumeration.h объявляет типы, необходимые для перечисления устройства.

Рекомендуется использовать директиву using namespace в cpp-файле, чтобы сделать код более удобочитаемым.
Объявите локальные переменные для приложения.Этот пример содержит числа, выбранных устройств и токенов регистрации, позволяющие ее позже отменять подписку на события.
```
// Counts the number of enumerated devices.
unsigned int deviceCount = 0;

// Event registration tokens that enable us to later unsubscribe from events.
EventRegistrationToken addedToken;
EventRegistrationToken stoppedToken;
EventRegistrationToken enumCompletedToken;
```

Инициализация Среда выполнения Windows.

// Initialize the Windows Runtime.
RoInitializeWrapper initialize(RO_INIT_MULTITHREADED);
if (FAILED(initialize))
{
    return PrintError(__LINE__, initialize);
}

Создайте объект События, который синхронизирует завершение процесса перечисления к основному приложению.

// Create an event that is set after device enumeration completes. We later use this event to wait for the timer to complete. 
// This event is for demonstration only in a console app. In most apps, you typically don't wait for async operations to complete.
Event enumerationCompleted(CreateEventEx(nullptr, nullptr, CREATE_EVENT_MANUAL_RESET, WRITE_OWNER | EVENT_ALL_ACCESS));
hr = threadCompleted.IsValid() ? S_OK : HRESULT_FROM_WIN32(GetLastError());
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

Примечание
Это событие для демонстрации только в составе приложения консоли.В этом примере используется событие, чтобы гарантировать, что операция токена, прежде чем приложение не влияет.В большинстве приложений, обычно не ожидает операции токена для выполнения.

Это событие для демонстрации только в составе приложения консоли.В этом примере используется событие, чтобы гарантировать, что операция токена, прежде чем приложение не влияет.В большинстве приложений, обычно не ожидает операции токена для выполнения.

Создание фабрики активации для интерфейса IDeviceWatcher.
```
// Get the activation factory for the IDeviceWatcher interface.
ComPtr<IDeviceInformationStatics> watcherFactory;
HRESULT hr = ABI::Windows::Foundation::GetActivationFactory(HStringReference(RuntimeClass_Windows_Devices_Enumeration_DeviceInformation).Get(), &watcherFactory);
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}
```
В Среда выполнения Windows используются полные имена для определения типов.Параметр RuntimeClass_Windows_Devices_Enumeration_DeviceInformation является строкой, предоставляемой Среда выполнения Windows и содержит требуемое имя класса среды выполнения.

Создайте объект IDeviceWatcher.

// Create a IDeviceWatcher object from the factory.
ComPtr<IDeviceWatcher> watcher;
hr = watcherFactory->CreateWatcher(&watcher);
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

Используйте функцию Callback для подписки на Added, EnumerationCompleted и Stopped события.

// Subscribe to the Added event.
hr = watcher->add_Added(Callback<AddedHandler>([&deviceCount](IDeviceWatcher* watcher, IDeviceInformation*) -> HRESULT
{
    // Print a message and increment the device count.
    // When we reach 10 devices, stop enumerating devices.
    wprintf_s(L"Added device...\n");
    deviceCount++;
    if (deviceCount == 10)
    {
        return watcher->Stop();
    }
    return S_OK;

}).Get(), &addedToken);
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

hr = watcher->add_Stopped(Callback<StoppedHandler>([=, &enumerationCompleted](IDeviceWatcher* watcher, IInspectable*) -> HRESULT
{
    wprintf_s(L"Device enumeration stopped.\nRemoving event handlers...");

    // Unsubscribe from the events. This is shown for demonstration.
    // The need to remove event handlers depends on the requirements of 
    // your app. For instance, if you only need to handle an event for 
    // a short period of time, you might remove the event handler when you
    // no longer need it. If you handle an event for the duration of the app,
    // you might not need to explicitly remove it.
    HRESULT hr1 = watcher->remove_Added(addedToken);
    HRESULT hr2 = watcher->remove_Stopped(stoppedToken);
    HRESULT hr3 = watcher->remove_EnumerationCompleted(enumCompletedToken);

    // Set the completion event and return.
    SetEvent(enumerationCompleted.Get());

    return FAILED(hr1) ? hr1 : FAILED(hr2) ? hr2 : hr3;

}).Get(), &stoppedToken);
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

// Subscribe to the EnumerationCompleted event.
hr = watcher->add_EnumerationCompleted(Callback<EnumerationCompletedHandler>([](IDeviceWatcher* watcher, IInspectable*) -> HRESULT
{
    wprintf_s(L"Enumeration completed.\n");

    return watcher->Stop();

}).Get(), &enumCompletedToken);
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

Обработчик событий Added увеличивает число перечисленных устройств.Он останавливает процесс перечисления после 10 устройств обнаружения.

Обработчик событий Stopped удаляет обработчики событий и задает событие завершения.

Обработчик событий EnumerationCompleted останавливает процесс перечисления.Рекомендуется обрабатываем это событие в случае до 10 устройств.

Совет
В этом примере лямбда-выражение используется для определения обратные вызовы.Можно также использовать объекты функций (functors), вызов функции или объекты std::function.Дополнительные сведения о лямбда-выражениях см. в разделе Lambda expressions in C++.

В этом примере лямбда-выражение используется для определения обратные вызовы.Можно также использовать объекты функций (functors), вызов функции или объекты std::function.Дополнительные сведения о лямбда-выражениях см. в разделе Lambda expressions in C++.

Запуск процесса перечисления.

wprintf_s(L"Starting device enumeration...\n");
hr = watcher->Start();
if (FAILED(hr))
{
    return PrintError(__LINE__, hr);
}

Подождите процесс перечисления, и затем вывести сообщение.Все объекты ComPtr и RAII покидает область и освобождаются автоматически.
```
// Wait for the operation to complete.
WaitForSingleObjectEx(enumerationCompleted.Get(), INFINITE, FALSE);

wprintf_s(L"Enumerated %u devices.\n", deviceCount);

// All smart pointers and RAII objects go out of scope here.
```

Ниже приведен полный пример.

// wrl-consume-events.cpp
// compile with: runtimeobject.lib
#include <Windows.Devices.Enumeration.h>
#include <wrl/event.h>
#include <stdio.h>

using namespace ABI::Windows::Devices::Enumeration;
using namespace ABI::Windows::Foundation;
using namespace Microsoft::WRL;
using namespace Microsoft::WRL::Wrappers;

// 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()
{
    // Type define the event handler types to make the code more readable.
    typedef __FITypedEventHandler_2_Windows__CDevices__CEnumeration__CDeviceWatcher_Windows__CDevices__CEnumeration__CDeviceInformation AddedHandler;
    typedef __FITypedEventHandler_2_Windows__CDevices__CEnumeration__CDeviceWatcher_IInspectable EnumerationCompletedHandler;
    typedef __FITypedEventHandler_2_Windows__CDevices__CEnumeration__CDeviceWatcher_IInspectable StoppedHandler;

    // Counts the number of enumerated devices.
    unsigned int deviceCount = 0;

    // Event registration tokens that enable us to later unsubscribe from events.
    EventRegistrationToken addedToken;
    EventRegistrationToken stoppedToken;
    EventRegistrationToken enumCompletedToken;

    // Initialize the Windows Runtime.
    RoInitializeWrapper initialize(RO_INIT_MULTITHREADED);
    if (FAILED(initialize))
    {
        return PrintError(__LINE__, initialize);
    }

    // Create an event that is set after device enumeration completes. We later use this event to wait for the timer to complete. 
    // This event is for demonstration only in a console app. In most apps, you typically don't wait for async operations to complete.
    Event enumerationCompleted(CreateEventEx(nullptr, nullptr, CREATE_EVENT_MANUAL_RESET, WRITE_OWNER | EVENT_ALL_ACCESS));
    hr = threadCompleted.IsValid() ? S_OK : HRESULT_FROM_WIN32(GetLastError());
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    // Get the activation factory for the IDeviceWatcher interface.
    ComPtr<IDeviceInformationStatics> watcherFactory;
    HRESULT hr = ABI::Windows::Foundation::GetActivationFactory(HStringReference(RuntimeClass_Windows_Devices_Enumeration_DeviceInformation).Get(), &watcherFactory);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    // Create a IDeviceWatcher object from the factory.
    ComPtr<IDeviceWatcher> watcher;
    hr = watcherFactory->CreateWatcher(&watcher);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    // Subscribe to the Added event.
    hr = watcher->add_Added(Callback<AddedHandler>([&deviceCount](IDeviceWatcher* watcher, IDeviceInformation*) -> HRESULT
    {
        // Print a message and increment the device count.
        // When we reach 10 devices, stop enumerating devices.
        wprintf_s(L"Added device...\n");
        deviceCount++;
        if (deviceCount == 10)
        {
            return watcher->Stop();
        }
        return S_OK;

    }).Get(), &addedToken);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    hr = watcher->add_Stopped(Callback<StoppedHandler>([=, &enumerationCompleted](IDeviceWatcher* watcher, IInspectable*) -> HRESULT
    {
        wprintf_s(L"Device enumeration stopped.\nRemoving event handlers...");

        // Unsubscribe from the events. This is shown for demonstration.
        // The need to remove event handlers depends on the requirements of 
        // your app. For instance, if you only need to handle an event for 
        // a short period of time, you might remove the event handler when you
        // no longer need it. If you handle an event for the duration of the app,
        // you might not need to explicitly remove it.
        HRESULT hr1 = watcher->remove_Added(addedToken);
        HRESULT hr2 = watcher->remove_Stopped(stoppedToken);
        HRESULT hr3 = watcher->remove_EnumerationCompleted(enumCompletedToken);

        // Set the completion event and return.
        SetEvent(enumerationCompleted.Get());

        return FAILED(hr1) ? hr1 : FAILED(hr2) ? hr2 : hr3;

    }).Get(), &stoppedToken);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    // Subscribe to the EnumerationCompleted event.
    hr = watcher->add_EnumerationCompleted(Callback<EnumerationCompletedHandler>([](IDeviceWatcher* watcher, IInspectable*) -> HRESULT
    {
        wprintf_s(L"Enumeration completed.\n");

        return watcher->Stop();

    }).Get(), &enumCompletedToken);
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    wprintf_s(L"Starting device enumeration...\n");
    hr = watcher->Start();
    if (FAILED(hr))
    {
        return PrintError(__LINE__, hr);
    }

    // Wait for the operation to complete.
    WaitForSingleObjectEx(enumerationCompleted.Get(), INFINITE, FALSE);

    wprintf_s(L"Enumerated %u devices.\n", deviceCount);

    // All smart pointers and RAII objects go out of scope here.
}
/*
Sample output:
Starting device enumeration...
Added device...
Added device...
Added device...
Added device...
Added device...
Added device...
Added device...
Added device...
Added device...
Added device...
Device enumeration stopped.
Removing event handlers...
Enumerated 10 devices.
*/

Компиляция кода

Чтобы компилировать код, он скопируйте и вставьте его в проект Visual Studio, или в файл с именем wrl-consume-events.cpp, затем выполните следующую команду в окне командной строки Visual Studio.

cl.exe wrl-consume-events.cpp runtimeobject.lib

См. также

Основные понятия

Библиотека шаблонов C++ среды выполнения Windows (WRL)

Поделиться через

Практическое руководство. Обработка событий с использованием WRL

Подписывание и обработки событий

Компиляция кода

См. также

Основные понятия

Дополнительные ресурсы