PrlSrvCfg_GetSerialPort Function

Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a serial port on the host.

Syntax

PRL_RESULT PrlSrvCfg_GetSerialPort(
    PRL_HANDLE hSrvConfig, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

PrlApiDisp.h

hSrvConfig

A handle of type PHT_SERVER_CONFIG .

nIndex

A numeric index identifying the port (beginning with 0). To get the number of ports available, use the PrlSrvCfg_GetSerialPortsCount function.

phDevice

[out] A pointer to a variable that receives a handle of type PHT_HW_GENERIC_DEVICE containing the port information.

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.