I2cTransferResult Struct

  • Reference

Definition

Namespace:
Windows.Devices.I2c
Edit

Provides information about whether the data transfers that the ReadPartial, WritePartial, or WriteReadPartial method performed succeeded, and the actual number of bytes the method transferred.

public value class I2cTransferResult
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Devices.DevicesLowLevelContract, 65536)]
struct I2cTransferResult
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Devices.DevicesLowLevelContract), 65536)]
public struct I2cTransferResult
var i2cTransferResult = {
status : /* Your value */,
bytesTransferred : /* Your value */
}
Public Structure I2cTransferResult
Inheritance
ValueType
I2cTransferResult
Attributes
ContractVersionAttribute

Windows requirements

Device family
Windows IoT Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Devices.DevicesLowLevelContract (introduced in v1.0)

Fields

BytesTransferred

The actual number of bytes that the operation actually transferred. The following table describes what this value represents for each method.

Method Description
ReadPartial The actual number of bytes that the read operation read into the buffer. If the value of the Status member is I2CTransferStatus.PartialTransfer, this value may be less than the number of bytes in the buffer that you specified in the buffer parameter.
WritePartial The actual number of bytes that the write operation transferred to the I2 C device. If the value of the Status member is I2CTransferStatus.PartialTransfer, this value may be less than the number of bytes in the buffer that you specified in the buffer parameter.
WriteReadPartial The actual number of bytes that the operation transferred, which is the sum of the number of bytes that the operation wrote and the number of bytes that the operation read. If the value of the Status member is I2CTransferStatus.PartialTransfer, this value may be less than the sum of lengths of the buffers that you specified in the writeBuffer and readBuffer parameters.
Status

An enumeration value that indicates if the read or write operation transferred the full number of bytes that the method requested, or the reason that the full transfer did not succeed. For WriteReadPartial, the value indicates whether the data for both the write and the read operations was entirely transferred.

Applies to

See also