ProSoft Technology MVI69-ADM - Manual (Page 263)

MVI-ADM ♦ 'C' Programmable Serial Port Library Functions
'C' Programmable Application Development Module Developer's Guide
ProSoft Technology, Inc. Page 263 of 342
February 20, 2013
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.
Note: MVI46 and MVI56 only.
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 (page 264)