Expand Minimize

WdfDeviceSetDeviceInterfaceState method

[Applies to KMDF and UMDF]

The WdfDeviceSetDeviceInterfaceState method enables or disables a device interface for a specified device.

Syntax


VOID WdfDeviceSetDeviceInterfaceState(
  [in]            WDFDEVICE Device,
  [in]            const GUID *InterfaceClassGUID,
  [in, optional]  PCUNICODE_STRING ReferenceString,
  [in]            BOOLEAN IsInterfaceEnabled
);

Parameters

Device [in]

A handle to a framework device object.

InterfaceClassGUID [in]

A pointer to a GUID that identifies the device interface class.

ReferenceString [in, optional]

A pointer to a UNICODE_STRING structure that describes a reference string for the device interface. This parameter is optional and can be NULL.

IsInterfaceEnabled [in]

A Boolean value that, if TRUE, enables the specified device interface instance or, if FALSE, disables it.

Return value

None.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about device interfaces and the WdfDeviceSetDeviceInterfaceState method, see Using Device Interfaces.

Examples

The following code example disables a driver's COM port interface.


WdfDeviceSetDeviceInterfaceState (
                                  Device,
                                  (LPGUID) &GUID_DEVINTERFACE_COMPORT,
                                  NULL,
                                  FALSE
                                  );

Requirements

Minimum KMDF version

1.0

Minimum UMDF version

2.0

Header

Wdfdevice.h (include Wdf.h)

Library

Wdf01000.sys (KMDF);
WUDFx02000.dll (UMDF)

IRQL

PASSIVE_LEVEL

DDI compliance rules

DriverCreate, KmdfIrql, KmdfIrql2

See also

UNICODE_STRING
WdfDeviceCreateDeviceInterface

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft