To get started with the 12d Synergy Client API, you will need to:

  1. Create a new Visual Studio Project in your chosen .net language
  2. Reference the following DLLS from the 12d Synergy Client installation path 
    SynergyClientAPI.dll 
    Contracts.dll 
    SynergyClient.dll 
     
    You should make sure Copy Local is set to FALSE
  3. In your main method, you should call 
    VB
    C#
    F#
    C++
    JScript
    Copy 
    SynergyClientAPI.General.Initialise();					
    This language is not supported or no code example is available.

  4. To begin a connection to the server, you should call: 

    VB
    C#
    F#
    C++
    JScript
    Copy 
    SynergyClientAPI.General.Connect(server_address);					
    This language is not supported or no code example is available.

Finding Jobs

You can find jobs in several ways:

  1. Prompt the user for a job/project, using SynergyClientAPI.Projects.PromptForProject
  2. Search for a job/project using SynergyClientAPI.Projects.SearchForProject
  3. Get the ID of a known job/project using SynergyClientAPI.General.GetEntityIDAndTypeFromPath

Deploying

Along with your own output assemblies, you will also need to copy in the SQL Server CE dlls, which can be found in your local client installation.

These are:

  1. sqlceca40.dll
  2. sqlcecompact40.dll
  3. sqlceer40en.dll
  4. sqlceme40.dll
  5. sqlceqp40.dll
  6. sqlcese40.dll