IOCTL_HAL_GET_POWER_DISPOSITION (Compact 2013)

10/16/2014

This I/O control message returns the disposition of the platform with respect to power usage. Send this message with OEMIoControl.

Syntax

BOOL OEMIoControl(
    DWORD dwIoControlCode,    // use IOCTL_HAL_GET_POWER_DISPOSITION
    LPVOID lpInBuffer,        // pointer to input buffer
    DWORD nInBufferSize,      // input buffer size
    LPVOID lpOutBuffer,       // pointer to output buffer
    DWORD nOutBufferSize,     // output buffer size
    LPDWORD lpBytesReturned  // number of bytes returned
);

Parameters

• dwIoControlCode
  [in] Control code for the operation. Use IOCTL_HAL_GET_POWER_DISPOSITION for this operation.

• lpInBuffer
  Not used; set to NULL.

• nInBufferSize
  Not used; set to zero.

• lpOutBuffer
  A power-disposition value, described in the following table:

  Value	Description
  POWER_DISPOSITION_ALWAYS_ON_AC	AC power only; no power management.
  POWER_DISPOSITION_ALWAYS_ON_IDLE_ONLY	AC or battery power if supported. The platform does not suspend and resume.
  POWER_DISPOSITION_SUSPENDRESUME_MANUAL	AC or battery power if supported. The platform can suspend, but only through a user-initiated action.
  POWER_DISPOSITION_SUSPENDRESUME_AUTO	AC or battery power if supported. The platform can suspend and resume through user action or an automatic time-out counter.
  POWER_DISPOSITION_OEM	OEM-defined value.

• nOutBufferSize
  [out] Size of lpOutBuffer.

• lpBytesReturned
  [out] Pointer to the number of bytes returned.

Return Values

Returns TRUE if successful; otherwise, returns FALSE.

Requirements

Header

pkfuncs.h

See Also

Reference

Power Manager IOCTLs