Previous

Next

Function RTUGetClientData

RTUGetClientData retrieves a pointer to client-private data previously set with RTUSetClientData:

void * RTUGetClientData(RTUDeviceHandle    Device, 
                        RTUConnectCallback ClientCallback);

Parameters

Device

Device handle passed to an attachment/detachment callback. If this value is NULL, the function returns NULL.

ClientCallback

Address of the client's attachment/detachment callback. This value must have been supplied to RTUClaimInterface and RTUSetClientData before it is used with this function.

return value

Pointer to the data to associate with the device for the specified client, or NULL if the function fails.

Unlike other functions in this section Device Configuration, RTUGetClientData may also be called from outside an attachment/detachment callback. However, a client must ensure that the referenced device has not been deallocated yet. This can be ensured by calling this function only while at least one pipe to the device is open.

Function RTUSetClientData

Function RTUResetDevice