IWDFUsbTargetDevice::SetPowerPolicy method

The SetPowerPolicy method sets the WinUsb power policy.

Syntax


HRESULT SetPowerPolicy(
  [in]  ULONG PolicyType,
  [in]  ULONG ValueLength,
  [in]  PVOID Value
);

Parameters

PolicyType [in]

The type of WinUsb power policy that the UMDF driver sets.

ValueLength [in]

The size, in bytes, of the buffer that SetPowerPolicy supplies in Value.

Value [in]

A pointer to the buffer that contains the WinUsb power policy.

Return value

SetPowerPolicy returns one of the following values:

Return codeDescription
S_OK

SetPowerPolicy successfully set the WinUsb power policy.

E_OUTOFMEMORY

SetPowerPolicy encountered an allocation failure.

An error code that is defined in Winerror.h

This value corresponds to the error code that the WinUsb API returned.

 

Remarks

Power policy controls the power management that WinUsb for the device performs.

For information about valid policy types and values that a UMDF driver can pass for the PolicyType and Value parameters, see the WinUsb_SetPowerPolicy function.

For more information about the power behavior of WinUSB, see WinUSB Power Management.

The SetPowerPolicy method generates a UMDF request and synchronously sends the request to the I/O target.

Requirements

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.5

Header

Wudfusb.h (include Wudfusb.h)

DLL

WUDFx.dll

See also

IWDFUsbTargetDevice
WinUsb_SetPowerPolicy
IWDFUsbTargetDevice::RetrievePowerPolicy

 

 

Send comments about this topic to Microsoft

Показ:
© 2014 Microsoft