GetSystemComHandle

int GetSystemComHandle (int COMPort, int *systemHandle);

Purpose

Returns the system port handle associated with a particular COM port. This handle can be used in Windows SDK functions.

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
Output
Name Type Description
systemHandle int (passed by reference) The system port handle for the particular COM port.

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.