Synergy Application Programming Interface (API)
The Synergy Application Programming Interface (API) is an Object Linking and Embedding (OLE) programming interface that enables certain functionality of this product to be automated.
Tip: Access the Synergy API reference documentation from the application Help menu. Click (Help > Synergy API Reference) to open the Application Programming Interface Documentation.
You can manipulate this product from scripts and third-party software.
To control this product through the API, you must have access to an OLE automation client. Examples of such clients include:
- Windows Script Host that can process Visual Basic Script (VBS), JScript, and other programming languages
- Visual Basic for Applications (VBA), a fully featured client that is part of the Microsoft Office application suite
- Visual Basic (VB)
- Internet Explorer
- Perl
- Python
This product can be automated by using the API in the following ways:
- Macros can be recorded and played from within the graphical user interface or from the product command line.
- VB scripts can be run from the product command line with or without command line arguments, or they can be run from within the user interface as macros.
You can launch a macro for a specific instance of Synergy on the local machine, using the InstanceID that you can find in the About box. In order to call a specific instance, your macro must include as its first line the following:
'%RunPerInstance
Note: Macros that were recorded, or hand-written, prior to the 2016 release should be edited to include this first line. If you do not include this line, you will receive a warning message and the first instance of Synergy that was executed will be called.