generic_samples: gettingstartedsample


Introduction

This sample shows how to instanciate a DcaInstance and a dca::License class and prints out all available informations about them.

It also shows how to use the classes:

Syntax:

gettinstartedsample <dca-redist-folder> <ticket> <product>
See also:

Files

file  generic_samples/gettingstartedsample/main.cpp
 

Getting started DCA sample.


Defines

#define DCA_BINDIR   "bin/linux"
 DCA subdirectory of the DCA binaries.
#define DCA_INITDIR   "init"
 DCA subdirectory of the DCA initialization data.
#define DCA_LOGDIR   "./logs"
 Relative directory for logfile(s).

Functions

static void PrintToolHeader ()
 Prints out the name and the version of this sample.
static void PrintUsage (const char *name)
 Prints out the syntax of the sample.
int main (int argc, char *argv[])
 The main routine.

Variables

const std::string S_UsageString
 Usage string, displayed if a parameter is missing.

Function Documentation

static void PrintUsage ( const char *  name  )  [static]

Prints out the syntax of the sample.

Parameters:
[in] name The name of the executable

Definition at line 97 of file generic_samples/gettingstartedsample/main.cpp.

int main ( int  argc,
char *  argv[] 
)

The main routine.

Parameters:
[in] argc The count of arguments provided
[in] argv An array of provided arguments
Returns:
5 on usage error, 10 on exception and internal error and 0 on success

Definition at line 110 of file generic_samples/gettingstartedsample/main.cpp.


Variable Documentation

const std::string S_UsageString
Initial value:
        "<dca-redist-folder> <ticket> <product>\n"
        "  dca-redist-folder - the folder where the DCA is installed to\n"
        "  ticket - a valid ticket\n"
        "  product - the product associated with your ticket\n\n"

Usage string, displayed if a parameter is missing.

Definition at line 54 of file generic_samples/gettingstartedsample/main.cpp.


Generated on 26 Sep 2016 for dca_interface by  doxygen 1.6.1