#SpringCardCompanionSvc

SpringCardCompanionSvc.exe is the executable that implements the background service.

#Syntax

SpringCardCompanionSvc.exe <ACTION> [OPTIONS]

Windows’ background services subsystem is allowed to invoke SpringCardCompanionSvc.exe without parameters.

When invoked from an interactive environment, one (and only one) ACTION parameter is required.

#ACTION parameters

#status: Query the service status

SpringCardCompanionSvc.exe --status [OPTIONS]

The service provides its status as a JSON object in the standard output. The JSON object is defined as follow:

Field	Type	Presence	Description
Installed	boolean	always	true if the background service is installed. false otherwise.
Running	boolean	always	true if the background service is started. false otherwise.
Version	string	always	The version of the background service executable.

#Example output

{"Running":false,"Installed":true,"Version":"18.4.6682.29793"}

#install: Install the service

SpringCardCompanionSvc.exe --install [OPTIONS]

Note: only system administrators can install a service. Regular users should add the --elevate option to the command-line.

#start: Start the service

SpringCardCompanionSvc.exe --start [OPTIONS]

Note: only system administrators can start a service. Regular users should add the --elevate option to the command-line.

#stop: Stop the service

SpringCardCompanionSvc.exe --stop [OPTIONS]

Note: only system administrators can stop a service. Regular users should add the --elevate option to the command-line.

#uninstall: Uninstall the service

SpringCardCompanionSvc.exe --uninstall [OPTIONS]

Note: only system administrators can uninstall a service. Regular users should add the --elevate option to the command-line.

#console: Run the service in console mode

SpringCardCompanionSvc.exe --console [OPTIONS]

Note: running a service is console mode is possible for regular users as well as for system administrators.

#OPTIONS parameters

#elevate: Perform UAC elevation (get admininistrator priviledges)

SpringCardCompanionSvc.exe [ACTION] --elevate

#verbose: Verbose output

SpringCardCompanionSvc.exe [ACTION] --verbose [level]

Allowed values for level are:

• 1 : show execution errors,
• 2 : show execution errors and warnings,
• 3 : show execution errors and warnings, and show a basic trace of the execution flow,
• 4 : all of the above, plus show a detailed trace of the execution flow (this slows down the process),
• 5 : all of the above, plus show a detailed trace of the underlying libraries (this slows down the process a lot).

If the level parameter is absent, default value is 4.

#pause: Keep the window open

SpringCardCompanionSvc.exe [ACTION] --pause

Use this flag when performing an ACTION to have enough time to read the messages. Hit the ENTER key to close the window when the application has terminated.