IPnpCallback::OnQueryStop 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.]

The OnQueryStop method notifies a driver before a device is stopped.

Syntax

HRESULT OnQueryStop(
  [in] IWDFDevice *pWdfDevice
);

Parameters

[in] pWdfDevice

A pointer to the IWDFDevice interface for the device object of the device that will be stopped.

Return value

If the driver determines that the device can be stopped, the OnQueryStop callback method must return S_OK or another status code for which SUCCEEDED(status) equals TRUE. Otherwise it must return a status code for which SUCCEEDED(status) equals FALSE. HRESULT error codes are defined in Winerror.h. Do not return HRESULT_FROM_NT(STATUS_NOT_SUPPORTED).

This method must use the HRESULT_FROM_NT macro to return a specific HRESULT value to return status to a kernel-mode client. For more information, see Supporting Kernel-mode Clients.

Remarks

A driver registers the IPnpCallback interface when it calls the IWDFDriver::CreateDevice method to create a device object.

The framework does not synchronize the OnQueryStop callback function with other PnP and power management callback functions.

OnQueryStop is not called in framework versions 1.7 and earlier.

For more information about the OnQueryStop callback method, see The PnP Manager Redistributes System Resources.

Requirements

Requirement	Value
Target Platform	Windows
Header	wudfddi.h (include Wudfddi.h)