Jump to main content

##

# 1.1.2.4.17 DRV_I2C_TRANSFER_HANDLE Typedef

## C

    typedef uintptr_t DRV_I2C_TRANSFER_HANDLE;

## Summary

Handle identifying a read, write or write followed by read transfer passed to the driver.

## Description

A transfer handle value is returned by a call to the DRV_I2C_ReadTransferAdd/ DRV_I2C_WriteTransferAdd or DRV_I2C_WriteReadTransferAdd functions. This handle is associated with the transfer passed into the function and it allows the application to track the completion of the data from (or into) that transfer. The transfer handle value returned from the "transfer add" function is returned back to the client by the "event handler callback" function registered with the driver.

The transfer handle assigned to a client request expires when the client has been notified of the completion of the buffer transfer (after event handler function that notifies the client returns) or after the transfer has been retired by the driver if no event handler callback was set.

## Remarks

None