GetSystemComHandle
- Updated2023-02-21
- 1 minute(s) read
int GetSystemComHandle (int portNumber, intptr_t *systemHandle);
Purpose
Returns the system port handle associated with a particular COM port. You can use this handle with Windows SDK functions.
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 |
| Output | ||
| Name | Type | Description |
| systemHandle | intptr_t | The system port handle for the particular COM port. |
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 5.5 and later