IRemoteInterfaceCallbackRemoval::OnRemoteInterfaceRemoval method

[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 OnRemoteInterfaceRemoval event callback function notifies the driver that it cannot use a device interface because the interface has been removed.

Syntax


void OnRemoteInterfaceRemoval(
  [in] IWDFRemoteInterface *pWdfRemoteInterface
);

Parameters

pWdfRemoteInterface [in]

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.

Return value

None.

Remarks

A driver's OnRemoteInterfaceRemoval event callback function must do whatever driver-specific tasks are necessary to handle removal of the device interface. In addition, the callback must delete the remote interface object that IWDFDevice2::CreateRemoteInterface created and call the interface's Release function if it has previously called the interface's AddRef function.

If the driver does not provide this callback function, the framework deletes the remote interface object that IWDFDevice2::CreateRemoteInterface created.

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

Requirements

Target platform

Desktop

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.9

Header

Wudfddi.h (include Wudfddi.h)

See also

IRemoteInterfaceCallbackRemoval
IPnpCallbackRemoteInterfaceNotification::OnRemoteInterfaceArrival
IRemoteInterfaceCallbackEvent::OnRemoteInterfaceEvent

 

 

Send comments about this topic to Microsoft

Show: