IRemoteTargetCallbackRemoval::OnRemoteTargetRemoveComplete method (wudfddi.h)

Article
02/22/2024

[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 OnRemoteTargetRemoveComplete event callback function performs operations that are necessary after the operating system completes the removal of a remote I/O target's device.

Syntax

void OnRemoteTargetRemoveComplete(
  [in] IWDFRemoteTarget *pWdfRemoteTarget
);

Parameters

[in] pWdfRemoteTarget

A pointer to the IWDFRemoteTarget interface of a remote target object that represents a remote I/O target. The driver obtains this pointer when it calls IWDFDevice2::CreateRemoteTarget.

Return value

None

Remarks

If your driver provides an OnRemoteTargetRemoveComplete event callback function, the callback function should do the following:

Do any driver-specific actions that your driver requires to close the remote I/O target.
Call IWDFRemoteTarget::Close.

If the driver does not provide this callback function, the framework calls IWDFRemoteTarget::Close for the driver.

For more information about the OnRemoteTargetRemoveComplete event callback function, see Controlling a General I/O Target's State in UMDF.

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)