IWDFDevice::GetPnpState 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.]

The GetPnpState method determines whether the given Plug and Play (PnP) property of a device is on or off (or set to the default state).

Syntax

WDF_TRI_STATE GetPnpState(
  WDF_PNP_STATE State
);

Parameters

State

A WDF_PNP_STATE-typed value that identifies the PnP property to retrieve status about.

Return Value

GetPnpState returns one of the following WDF_TRI_STATE-typed values that identifies the state of the PnP property that is specified in the State parameter.

Return code Description
WdfUseDefault (0)
The PnP property is set to the default state.
WdfFalse (1)
The PnP property is turned off.
WdfTrue (2)
The PnP property is turned on.

Requirements

   
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

IWDFDevice

IWDFDevice::SetPnpState

WDF_PNP_STATE