Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PHT_VIRTUAL_DEV_SERIAL_PORT
Functions  Functions by Handle  Legend  See Also

The PHT_VIRTUAL_DEV_SERIAL_PORT handle is used to manage serial ports in a virtual machine. The handle is obtained by making the PrlVmCfg_CreateVmDev or the PrlVmCfg_GetSerialPort function call.

Description

The following describes how to create new or modify an existing serial port on a virtual machine. 

First, you have to set the emulation type using the PrlVmDev_SetEmulatedType function. The available types are:

  • PDT_USE_REAL_DEVICE - real port.
  • PDT_USE_OUTPUT_FILE - output file.
  • PDT_USE_OTHER - socket.

Second, you must call the PrlVmDev_SetSysName and the PrlVmDev_SetFriendlyName functions. These functions are used differently depending on the emulation type that you chose in the first step. 

Real port 

  1. Choose a real port and pass its ID to the PrlVmDev_SetSysName function.
  2. Pass the physical port name to the PrlVmDev_SetFriendlyName function.

Output file

  1. Choose an output file name and path, then pass it to both functions as a parameter.

Socket

  1. Choose a socket name and path, then pass it to both functions as a parameter.
  2. Call the PrlVmDevSerial_SetSocketMode function to set the socket mode.
Functions
 
Name 
Description 
 
Returns the socket mode of a virtual serial port. 
 
Sets the socket mode for a virtual serial port. 
See Also
Links
© 2021 Parallels International GmbH. All rights reserved.