FlushOutQ
- Updated2023-02-21
- 1 minute(s) read
int FlushOutQ (int portNumber);
Purpose
Removes all characters from the output queue of the specified port.
FlushOutQ returns an error if you have not opened the port or if you pass an invalid value for portNumber.
Parameters
| Input | ||
| Name | Type | Description |
| portNumber | int | A number that indicates the COM port on which to operate. This number maps to the COM port specified by deviceName in the call to OpenCom or OpenComConfig. The portNumber 1, for example, may not necessarily map to COM1. (Linux) The portNumber 1, for example, may not necessarily map to /dev/ttyS0. Valid Range: 1—1,000 |
Return Value
| Name | Type | Description |
| returnValue | int | The result of this function call. This code is a negative value that specifies the type of error that occurred. |
Additional Information
Library: RS-232 Library
Include file: rs232.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Examples
Refer to the following examples that use the FlushOutQ function:
- rs232\commcallback.cws
Open example - rs232\serial.cws
Open example