C++ API Library Setup: Difference between revisions

From RangerMSP Wiki - PSA software for MSPs and IT services providers
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Decompress the downloaded archive to a destination folder of your choice. In the root folder '''CommitCRM-CPP''' you’ll find two solution files:


* '''CommitCRM-CPP-2008.sln''' – for Visual Studio 2008  
== Headline text ==
* '''CommitCRM-CPP-2010.sln''' – for Visual Studio 2010
Decompress the downloaded archive to a destination folder of your choice. In the root folder '''CRM-CPP''' you’ll find two solution files:
 
* '''CRM-CPP-2008.sln''' – for Visual Studio 2008  
* '''CRM-CPP-2010.sln''' – for Visual Studio 2010


Depending of what version is installed on the local computer, open the one or the other solution file.
Depending of what version is installed on the local computer, open the one or the other solution file.
Line 8: Line 10:
The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.  
The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.  


After everything is compiled, locate the '''sample1.cpp''' file in the '''Sample1''' project and ensure that '''config.CommitDllFolder''' and '''config.CommitDbFolder''' point to the correct paths on your computer  (<your-server>\CommitCRM\ThirdParty\UserDev and <your-server>\CommitCRM\Db  accordingly)..
After everything is compiled, locate the '''sample1.cpp''' file in the '''Sample1''' project and ensure that '''config.DllFolder''' and '''config.DbFolder''' point to the correct paths on your computer  (<your-server>\RangerMSP\ThirdParty\UserDev and <your-server>\RangerMSP\Db  accordingly)..


The file has many comments explaining each step, we recommend examining '''sample1.cpp''' source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.
The file has many comments explaining each step, we recommend examining '''sample1.cpp''' source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.


To use the library in your own project you’ll have to link to the '''CommitLib.lib''' (the static library will be created after compiling the source code) and add the Source folder to the '''INCLUDE''' path for your compiler (this is already done for the '''Sample1''' project).
To use the library in your own project you’ll have to link to the '''CRMLib.lib''' (the static library will be created after compiling the source code) and add the Source folder to the '''INCLUDE''' path for your compiler (this is already done for the '''Sample1''' project).


[[CommitCRM_C%2B%2B_API|Back to CommitCRM C++ API Page]]
[[C%2B%2B_API|Back to RangerMSP C++ API Page]]

Latest revision as of 08:01, 8 July 2020

Headline text

Decompress the downloaded archive to a destination folder of your choice. In the root folder CRM-CPP you’ll find two solution files:

  • CRM-CPP-2008.sln – for Visual Studio 2008
  • CRM-CPP-2010.sln – for Visual Studio 2010

Depending of what version is installed on the local computer, open the one or the other solution file.

The distributed files are plain source files (there are no precompiled files included), so you’ll have to rebuild the whole solution.

After everything is compiled, locate the sample1.cpp file in the Sample1 project and ensure that config.DllFolder and config.DbFolder point to the correct paths on your computer (<your-server>\RangerMSP\ThirdParty\UserDev and <your-server>\RangerMSP\Db accordingly)..

The file has many comments explaining each step, we recommend examining sample1.cpp source file before executing the compiled program. In a nutshell, the sample will search for an account (if it doesn’t find it, it will create new one), and then demonstrates adding/searching for a ticket and adding/listing charges.

To use the library in your own project you’ll have to link to the CRMLib.lib (the static library will be created after compiling the source code) and add the Source folder to the INCLUDE path for your compiler (this is already done for the Sample1 project).

Back to RangerMSP C++ API Page