116
FlushComm
int FlushComm(idComDev, fnQueue)
int idComDev;
/* Identifier of the communication device */
int fnQueue;
/* Queue to be flushed */
The FlushComm function is used to flush out all characters from the transmission queue or reception
queue of the communication device.
< Parameter >
idComDev
: Specifies the communication device to be flushed. The OpenComm function returns
this value.
fnQueue
: Specifies the queue to be flushed. If this parameter is set to 0, the transmission queue
is flushed, and if set to 1, the reception queue is flushed.
< Return value >
Returns zero if the function is terminated normally. If the device specified by the idComDev
parameter is not valid, or if the queue specified by the fnQueue parameter is not valid, a value other
than zero is returned. If the specified device has an error, a positive value will be returned.
For more information about the error values refer to the GetCommError function description.
Note on IrDA:
Data transmission will take place only after the transmitted characters have been passed from the
transmission queue to the buffer in the IrDA driver. Even if the transmission/reception buffer
contains zero bytes, untransmitted data or received data may remain in the IrDA driver.