Windows: Getting started with samples

See also:
dca\samples\readme.txt

Preparation

You need set up the 3rd party libraries before you can build the samples.

See also Chapter: Requirements for using the SCA on Windows.

Open a Visual Studio Command prompt (Start menu -> Visual Studio 2008 -> Visual Studio Tools -> Visual Studio Command Prompt)

Change directory to the SCA samples folder e.g.:

C:\> cd dca\samples

Edit the file setup_dca_env_vars.cmd

C:\dca\samples\> notepad setup_dca_env_vars.cmd

Change the lines:

set DCA_REDIST_DIR=C:\dca
set SYS_LIBS=C:\dca\osslibs

to correctly point to your dca-installation-folder and the 3rd_party libraries' build directory (see 3rd Party Libraries - How to build and setup (Windows)).

Also change the line

set CURL_CA_BUNDLE=c:\dca\osslibs\ca-bundle.crt

to correctly point to the CA bundle file needed by cUrl (see also Initialization of 3rd party libraries).

Save your changes to the file.

Compiling Samples

After preparation you can build the samples by using the provided cmd files e.g:

C:\dca\samples\> cd generic_samples
C:\dca\samples\generic_samples\> run_samples.cmd

run_samples.cmd will first call the setup_dca_env_vars.cmd script and then it will open up Visual Studio 2008 with the generic_samples.sln solution file.

Build your solution/project as usual.

Running Samples

All samples support the following command line parameters:

Syntax: sample <dca-install-dir> <ticket> <product> [sample-specific]

dca-install-dir

This is the installation folder of the SCA, e.g.:
C:\dca

ticket

This is the ticket as shown on the SDK Download homepage e.g.:
"DCXX-1234-...."

product

This is the product key associated with your ticket as shown on the SDK Download homepage e.g.:
"AB"

[sample-specific]

Additionally to the common command line parameters, some samples need additional parameters e.g. where to find test files.

Refer to the specific sample description for further details.

To start e.g. the already built getversionsample.exe supply the parameters (either in the internal Visual Studio Debugger or at the command prompt):

set dca_install_dir="C:\dca"
set myticket="DCXX-1234...."
set myproduct="AB"
getversionsample.exe %dca_install_dir% %myticket% %myproduct%

The sample writes the log file:

.\logs\dca_info.log

The dca_info.log shows details on what's happening inside of the SCA.

Note:

The log file is being reused by restarting the sample. All newer log lines will be appended.

Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1