Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.15 KB

i2ctransferstatus.md

File metadata and controls

43 lines (28 loc) · 2.15 KB
-api-id -api-type
T:Windows.Devices.I2c.I2cTransferStatus
winrt enum

I2cTransferStatus

-description

Describes whether the data transfers that the ReadPartial, WritePartial, or WriteReadPartial method performed succeeded, or provides the reason that the transfers did not succeed.

-enum-fields

-field FullTransfer:0

The data was entirely transferred. For WriteReadPartial, the data for both the write and the read operations was entirely transferred.

For this status code, the value of the I2cTransferResult.BytesTransferred member that the method returns is the same as the size of the buffer you specified when you called the method, or is equal to the sum of the sizes of two buffers that you specified for WriteReadPartial.

-field PartialTransfer:1

The I2 C device negatively acknowledged the data transfer before all of the data was transferred.

For this status code, the value of the I2cTransferResult.BytesTransferred member that the method returns is the number of bytes actually transferred. For WriteReadPartial, the value is the sum of the number of bytes that the operation wrote and the number of bytes that the operation read.

-field SlaveAddressNotAcknowledged:2

The bus address was not acknowledged.

For this status code, the value of the I2cTransferResult.BytesTransferred member that the method returns of the method is 0.

-field ClockStretchTimeout:3

The transfer failed due to the clock being stretched for too long. Ensure the clock line is not being held low.

-field UnknownError:4

The transfer failed for an unknown reason.

-remarks

-examples

-see-also

ReadPartial, WritePartial, WriteReadPartial, I2cTransferResult