Documentation

Mistake on this page? Email us
Data Fields
pt_device_userdata_s Struct Reference
Protocol translator API v1

Contains fields for client user data. More...

#include <pt_api.h>

Data Fields

void * data
 
pt_device_free_userdata_cb_t pt_device_free_userdata
 

Detailed Description

Contains fields for client user data.

Deprecated:
The protocol translator API v1 is deprecated. The API will exist until end of 2019.

If the client wants to associate data with the device, this structure may be used. Create this structure using pt_api_create_device_userdata. The PT API will deallocate this structure and call the pt_device_free_userdata call-back when the pt_device_t structure is destroyed. However the client is responsible to free the pt_device_userdata_t::data using the pt_device_userdata_t::pt_device_free_userdata call-back or in some other way.

Field Documentation

void* pt_device_userdata_s::data

Pointer to client's data that may be associated with the device.

pt_device_free_userdata_cb_t pt_device_userdata_s::pt_device_free_userdata

Points to customer implementation to free the userdata.

The documentation for this struct was generated from the following file: