PI2C_READ callback function (video.h)

Article
02/22/2024

The I2CRead function reads data over the I2C channel.

Syntax

PI2C_READ Pi2cRead;

BOOLEAN Pi2cRead(
  [in]  IN PVOID HwDeviceExtension,
  [in]  IN PI2C_CALLBACKS I2CCallbacks,
  [out] OUT PUCHAR Buffer,
  [in]  IN ULONG Length
)
{...}

Parameters

[in] HwDeviceExtension

Pointer to the miniport driver's per-adapter device extension.

[in] I2CCallbacks

Pointer to an I2C_CALLBACKS structure, containing pointers to miniport driver-defined functions that read and write data and clock lines.

[out] Buffer

Pointer to the data to be read.

[in] Length

Specifies the number of bytes to be read.

Return value

I2CRead returns TRUE if the data was successfully read, and FALSE otherwise.

Remarks

The video port implements this function, which can be accessed through a pointer in the VIDEO_PORT_I2C_INTERFACE structure.

Requirements

Requirement	Value
Minimum supported client	Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform	Desktop
Header	video.h (include Video.h)
IRQL	PASSIVE_LEVEL