Publication 1756-RM004B-EN-P - October 2000
Serial Port API 5-33
MVIsp_PurgeDataUnsent
Syntax:
int MVIsp_PurgeDataUnsent(int comport);
Parameters:
comport port whose transmit data is to be purged
Description:
MVIsp_PurgeDataUnsent deletes all data waiting in the transmit
queue. The data is discarded and is not transmitted.
comport specifies the port whose transmit queue is to be purged.
Return Value:
MVI_SUCCESS the data was purged successfully
MVI_ERR_BADPARAM invalid comport
MVI_ERR_NOACCESS the comport has not been opened
Example:
if (MVIsp_PurgeDataUnsent(COM1) = = MVI_SUCCESS)
printf(“Transmit Data purged.\n”);
See Also:
MVIsp_PurgeDataUnread