PrlVmCfg_GetSerialPort Function

Obtains a handle of type PHT_VIRTUAL_DEV_SERIAL_PORT containing information about a serial port in a virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetSerialPort(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

nIndex

An index identifying the serial port instance.

phDevice

[out] A pointer to a variable that receives the handle.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed, or device index out of bound.

PRL_ERR_SUCCESS - function completed successfully.