Command Line Interface

Use ftsprrdctl.exe console program to map serial ports via command line interface.

Command line ftsprrdctl.exe file is created during the program install. You can find it within Serial Port for Remote Desktop program folder.

Command-line syntax cheat sheet

Notation	Example	Description
Text without brackets	command	Items which must be typed as shown.
Text in square brackets	[optional]	Optional parameter.
Text in angle brackets	<value>	Placeholder for user-provided values.
Text in curly braces	{ required_value =0\|=1 }	Group of required choices. At least one option must be included.
Pipe	option_1\|option_2	Divider between alternative options. Only one option can be selected.

Serial Port for Remote Desktop console utility
Copyright (с) 2000-2024 FabulaTech 

Usage: ftsprrdctl.exe command [option]

Syntax:

enum [-d] [-i] [-r] [-m] [-s] [-b] [{-p|-P} COM<number>] [-u|-l <locale>] 
[-t <seconds>]
                                List information about COM ports in the table
                                form, with the specified columns:
                                -d - description;
                                -i - hardware ID;
                                -r - physical port name;
                                -m - USB path (for USB-to-serial devices);
                                -s - status (one of Connected, Connecting,
                                Opened, Available, Missing).

                                Displaying options:
                                -b - Alternate output for batch processing.
                                -p COM<number> - display information only about 
                                the physical COM port identified by its number.
                                -P COM<number> - display information only about 
                                the virtual COM port identified by its number.
                                -u - set output encoding to Unicode.
                                -l <locale> - set output encoding to specified
                                locale.
                                -t <seconds> - Limit communication timeout for
                                specified number of seconds and exit with error
                                code if exceeded. Default value is 0 (infinite).

update -s|-p                    Update service settings or port settings for all
                                open sessions.
key                             Display the current license key information.
key <path>                      Apply the license key from the file.
log show|clear                  Display or clear the program log.
log level error|debug           Set the logging level to error or debug.
help|/?                         Show this help.     

The program will return one of the following exit codes to the standard variable 
%ERRORLEVEL%:
0 - success;
1 - failure;
2 - invalid parameters;
3 - API initialization error;
4 - communication timeout exceeded;
5 - stopped by control signal (Ctrl+Break, Ctrl+C);
6 - service unavailable.

Command Line Usage Examples:

List COM ports with their description, hardware ID and status:

C:\Program Files\FabulaTech\Serial Port for Remote Desktop (Server)>ftsprrdctl.exe enum -d -i -s
Name      Status        HardwareID                              Description
COM1      Available     ACPI\VEN_PNP&DEV_0501                   Communications Port

Update service settings for all open sessions:

C:\Program Files\FabulaTech\Serial Port for Remote Desktop (Server)>ftsprrdctl.exe update -s