IRemoteInterfaceCallbackEvent::OnRemoteInterfaceEvent method (wudfddi.h)

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

A UMDF-based driver's OnRemoteInterfaceEvent event callback function handles device events that are associated with a device interface.

Syntax

void OnRemoteInterfaceEvent(
  [in]           IWDFRemoteInterface *pWdfRemoteInterface,
  [in]           REFGUID             EventGuid,
  [in, optional] BYTE                *pbData,
  [in]           DWORD               cbDataSize,
  [in]           DWORD               NameBufferOffset
);

Parameters

[in] pWdfRemoteInterface

A pointer to the IWDFRemoteInterface interface of a remote interface object that represents a device interface. The driver obtains this pointer when it calls IWDFDevice2::CreateRemoteInterface.

[in] EventGuid

A GUID that identifies the event type. Event GUIDs are defined by the components that support such GUIDs. Some device interface classes provide event GUIDs, and some driver provide custom events.

[in, optional] pbData

A pointer to a buffer that contains event-specific data. Typically, components that define event GUIDs also define event-specific structures for event buffers.

[in] cbDataSize

The size, in bytes, of the buffer that pbData points to.

[in] NameBufferOffset

An offset, in bytes, from the beginning of the buffer that pbData points to. Bytes from 0 to NameBufferOffset-1 of the buffer contain binary data. Bytes from NameBufferOffset to the end of the buffer contain Unicode string data.

Return value

None

Remarks

A driver's OnRemoteInterfaceEvent event callback function handles all device events except arrival and removal events. Such events can originate from a UMDF-based driver's call to IWDFDevice::PostEvent or from a kernel-mode driver's call to IoReportTargetDeviceChange or IoReportTargetDeviceChangeAsynchronous.

The framework begins calling the OnRemoteInterfaceEvent event callback function after the driver calls IWDFRemoteTarget::OpenRemoteInterface and continues to call the callback function until the device interface's remote I/O target is closed.

For more information about a driver's OnRemoteInterfaceEvent event callback function, see Using Device Interfaces in UMDF-based Drivers.

Requirements

Requirement Value
End of support Unavailable in UMDF 2.0 and later.
Target Platform Desktop
Minimum UMDF version 1.9
Header wudfddi.h (include Wudfddi.h)

See also

IPnpCallbackRemoteInterfaceNotification::OnRemoteInterfaceArrival

IRemoteInterfaceCallbackEvent

IRemoteInterfaceCallbackRemoval::OnRemoteInterfaceRemoval