IRemoteInterfaceCallbackEvent::OnRemoteInterfaceEvent method

[Applies to UMDF 1.x only]

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

pWdfRemoteInterface [in]

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

EventGuid [in]

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.

pbData [in, optional]

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

cbDataSize [in]

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

NameBufferOffset [in]

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

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.9

Header

Wudfddi.h (include Wudfddi.h)

See also

IRemoteInterfaceCallbackEvent
IPnpCallbackRemoteInterfaceNotification::OnRemoteInterfaceArrival
IRemoteInterfaceCallbackRemoval::OnRemoteInterfaceRemoval

 

 

Send comments about this topic to Microsoft

표시:
© 2014 Microsoft