FlushOutQ

int FlushOutQ (int COMPort);

Purpose

Removes all characters from the output queue of the specified port.

FlushOutQ returns an error if you have not opened the port of if you pass an invalid value for COMPort.

Parameters

Input
Name Type Description
COMPort integer A number that indicates the COM port on which to operate.

This number is paired with deviceName, which represents the COM port, during the OpenComConfig function call.

Default Value: 1—COM1
Valid Range: 1—1,000

Return Value

Name Type Description
result integer The result of this function call. This code is a negative value that specifies the type of error that occurred.