user_write_point_quality

Writes point quality data to the specified device.

You can find the template for this subroutine in:

usrtm_wrtpqual.c

Syntax

void user_write_point_quality(DEVICE_DATA *device_struct,
????????????????????????????????????????????????????????????ADDR_DATA *address_struct,
????????????????????????????????????????????????????????????TOOLKIT_QUALDATA *pqualdata,
??????????????????????????????????????????????????????????int *comm_status,
??????????????????????????????????????????????????????????int *status)

Input Parameters

device_struct

Is a pointer to the structure defining device data. DEVICE_DATA is a typedef to a structure defined in <inc_path/toolkit.h>.

address_struct

Is a pointer to the address from which the data was read. ADDR_DATA is a typedef to a structure defined in <inc_path/toolkit.h>.

pqualdata

Is the pointer to the quality data to be written. TOOLKIT_QUALDATA is a typedef to a structure defined in <inc_path/toolkit.h>.

Output Parameters

comm_status

Indicates whether a status of TOOLKIT_FAILURE occurred as a result of a communication failure. Valid values are:

TOOLKIT_SUCCESS Failure is not due to communications failure.
TOOLKIT_WRITE_FAILED Could not send command or data to device.
TOOLKIT_TIMEOUT Sent command or data to device, timed-out waiting for a response.
TOOLKIT_FAILURE Failure is due to communications failure.

status

Indicates whether the function read all the data. Valid values are:

TOOLKIT_SUCCESS Function completed successfully.
TOOLKIT_REPLY_LATER Write request queued for future processing.
TOOLKIT_FAILURE Function did not complete successfully. Check comm_status to see if the failure was the result of a communication failure.

Return Value

None.