Edit

IWDFIoTargetStateManagement::Remove method (wudfddi.h)

  • Article

[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.]

The Remove method removes a local I/O target.

Syntax

HRESULT Remove(
  [in] BOOL bIsSurpriseRemove
);

Parameters

[in] bIsSurpriseRemove

A BOOL value which, if TRUE, specifies that the device was unexpectly removed ("surprise removal"). However, the framework ignores this parameter.

Return value

Remove always returns S_OK.

Remarks

Although the Remove method is available, drivers do not need to call it. If a driver has called IWDFFileHandleTargetFactory::CreateFileHandleTarget to create a file-handle-based I/O target, the driver should call IWDFObject::DeleteWdfObject to delete the I/O target object after the driver has finished using the file-handle-based target. The DeleteWdfObject method performs the operations that Remove performs, along with additional operations.

Requirements

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

See also

IWDFIoTargetStateManagement