Engage Engine Result Codes

Variables
static const int	ENGAGE_RESULT_OK = 0
	The request was succesful.
static const int	ENGAGE_RESULT_INVALID_PARAMETERS = -1
	One or more parameters are invalid.
static const int	ENGAGE_RESULT_NOT_INITIALIZED = -2
	The library has not yet been initialized - engageInitialize() should be called.
static const int	ENGAGE_RESULT_ALREADY_INITIALIZED = -3
	The library has already been initialized.
static const int	ENGAGE_RESULT_GENERAL_FAILURE = -4
	An unspecified error has occurred.
static const int	ENGAGE_RESULT_NOT_STARTED = -5
	The Engine has not yet been started - engageStart() should be called.
static const int	ENGAGE_RESULT_ALREADY_STARTED = -6
	The Engine has already been started.
static const int	ENGAGE_RESULT_INSUFFICIENT_DESTINATION_SPACE = -7
	Insufficient space in destination.
static const int	ENGAGE_RESULT_CRYPTO_MODULE_INITIALIZATION_FAILED = -8
	Initialization of the crypto module failed.
static const int	ENGAGE_RESULT_HIGH_RES_TIMER_ALREADY_EXISTS = -9
	An application high resolution timer is already defined.

Detailed Description

Result codes are returned by calls to the API functions and most often are related to the submission of a request to Engage rather than the outcome of that submission.

For example: a call to engageStart resulting in a return value of ENGAGE_RESULT_OK simply means that the request to asychronously start Engage has been successfully submitted. That asynchronous operation will report back later on the outcome by means of an ON_ENGINE_STARTED event.

Variable Documentation

ENGAGE_RESULT_ALREADY_INITIALIZED

const int ENGAGE_RESULT_ALREADY_INITIALIZED = -3

static

The library has already been initialized.

Definition at line 97 of file EngageConstants.h.

ENGAGE_RESULT_ALREADY_STARTED

const int ENGAGE_RESULT_ALREADY_STARTED = -6

static

The Engine has already been started.

Definition at line 103 of file EngageConstants.h.

ENGAGE_RESULT_CRYPTO_MODULE_INITIALIZATION_FAILED

const int ENGAGE_RESULT_CRYPTO_MODULE_INITIALIZATION_FAILED = -8

static

Initialization of the crypto module failed.

Definition at line 107 of file EngageConstants.h.

ENGAGE_RESULT_GENERAL_FAILURE

const int ENGAGE_RESULT_GENERAL_FAILURE = -4

static

An unspecified error has occurred.

Definition at line 99 of file EngageConstants.h.

ENGAGE_RESULT_HIGH_RES_TIMER_ALREADY_EXISTS

const int ENGAGE_RESULT_HIGH_RES_TIMER_ALREADY_EXISTS = -9

static

An application high resolution timer is already defined.

Definition at line 109 of file EngageConstants.h.

ENGAGE_RESULT_INSUFFICIENT_DESTINATION_SPACE

const int ENGAGE_RESULT_INSUFFICIENT_DESTINATION_SPACE = -7

static

Insufficient space in destination.

Definition at line 105 of file EngageConstants.h.

ENGAGE_RESULT_INVALID_PARAMETERS

const int ENGAGE_RESULT_INVALID_PARAMETERS = -1

static

One or more parameters are invalid.

Definition at line 93 of file EngageConstants.h.

ENGAGE_RESULT_NOT_INITIALIZED

const int ENGAGE_RESULT_NOT_INITIALIZED = -2

static

The library has not yet been initialized - engageInitialize() should be called.

Definition at line 95 of file EngageConstants.h.

ENGAGE_RESULT_NOT_STARTED

const int ENGAGE_RESULT_NOT_STARTED = -5

static

The Engine has not yet been started - engageStart() should be called.

Definition at line 101 of file EngageConstants.h.

ENGAGE_RESULT_OK

const int ENGAGE_RESULT_OK = 0

static

The request was succesful.

Definition at line 91 of file EngageConstants.h.