Virtual Serial Port Tools incorporated the functionality of former HHD Software product Virtual Serial Ports. Currently, this functionality was almost entirely left untouched and works almost like in that previous product. Therefore a separate command-line utility is used to create virtual bridges, pipe-connected ports and listening ports.
Command-line utility vysercli.exe may be used as a simple API to create and manage virtual serial ports and bridges. Command-line utility returns 0 if the requested operation completed successfully, or non-zero error code (HRESULT). It also prints error description to STDOUT unless the --silent parameter is specified.
The utility supports the following command-line parameters:
| Parameter | Value | Description |
|---|---|---|
-?, --help | Displays the list of supported parameters with short description. | |
--silent | Do not display any error or success messages. | |
-create, --create | (port|bridge|remote-bridge) | Create port, bridge or remote bridge. See the details below on supported parameters for each type. |
-delete, --delete | (N1,[N2,[N3...]]) | Delete one or more serial ports. |
| Local Bridge Creation | ||
--coms | N1,N2 | Specify COM port numbers for created devices. Optional parameter. If omitted, port numbers are assigned automatically. If the specified COM port number is already being used, an error is returned. |
--permanent | Make the created bridge permanent, that is, it is automatically recreated after the system restarts. | |
| Remote Bridge Creation | ||
--remote-host | hostname | Remote host name or IP-address. |
--remote-port | N | COM port number of the port on remote computer. |
--com | N | Local port number. Optional parameter. If omitted, the port number is automatically assigned. If the specified port number is already being used, an error is returned. |
--permanent | Make the created bridge permanent, that is, it is automatically recreated after the system restarts. | |
--login | username | Login of the user for authentication on remote computer. Optional for non-permanent bridges. |
--password | password | Password of the user for authentication on remote computer. Optional for non-permanent bridges. |
--domain | hostname | Domain of the user for authentication on remote computer. Optional parameter. |
| Ports Creation | ||
--com | N | Local port number. Optional parameter. If omitted, the port number is automatically assigned. If the specified port number is already being used, an error is returned. |
--mode | (listening|pipe|files) | Created port mode |
| Listening port | ||
--security | SD | String security identifier for listening port access control. |
| Pipe port | ||
--create-pipe | pipename | Specify pipe name to create and connect to. Required unless --connect-pipe parameter is specified. |
--connect-pipe | pipename | Specify pipe name to connect to. Required unless --create-pipe parameter is specified. |
| Input/Output files port | ||
--input-file | filename | Specify the input file name. |
--output-file | filename | Specify the output file name. |