Edit

UCM_PD_POWER_DATA_OBJECT_INIT_ULONG function (ucmtypes.h)

  • Article

Initializes a UCM_PD_POWER_DATA_OBJECT structure by interpreting Power Data Object values and sets each field correctly.

Syntax

void UCM_PD_POWER_DATA_OBJECT_INIT_ULONG(
  [out] PUCM_PD_POWER_DATA_OBJECT Pdo,
  [in]  ULONG                     UlongInLittleEndian
);

Parameters

[out] Pdo

A pointer to a UCM_PD_POWER_DATA_OBJECT structure.

[in] UlongInLittleEndian

The ULONG value to set in the Ul member of UCM_PD_POWER_DATA_OBJECT.

Return value

None

Remarks

A Power Data Object, as defined by the Power Delivery specification, is a 32-bit value. The hardware is expected to retrieve the Power Data Objects as 32-bit values. This utility function initializes a UCM_PD_POWER_DATA_OBJECT structure by interpreting those values and setting each field correctly.

The 4 byte value is expected to be in little-endian format. The structure is 4 bytes and the client driver can memcopy the Power Data Objects from the hardware into an array of UCM_PD_POWER_DATA_OBJECT structures.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Target Platform Windows
Minimum KMDF version 1.15
Minimum UMDF version 2.15
Header ucmtypes.h (include Ucmcx.h)

See also

UCM_PD_POWER_DATA_OBJECT