GetInQLen
- Updated2023-02-21
- 1 minute(s) read
int GetInQLen (int portNumber);
Purpose
Returns the number of characters in the input queue of a COM port. GetInQLen does not change the input queue.
GetInQLen 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 |
| inputQueueLength | int | The current length of the input queue. |
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 GetInQLen function:
- rs232\commcallback.cws
Open example - rs232\serial.cws
Open example