GetOutQLen
- Updated2023-02-21
- 1 minute(s) read
int GetOutQLen (int portNumber);
Purpose
Returns the number of characters in the output queue of the specified port.
You can use GetOutQLen to ensure the output queue empties before you close the port. This function has no effect on the output queue.
GetOutQLen 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 |
| outputQueueLength | int | The current length of the output queue. |
Additional Information
Library: RS-232 Library
Include file: rs232.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Example
Refer to rs232\serial.cws for an example of using the GetOutQLen function.