Entr'ouvert Entr'ouvert Documentation

Initialization functions

Initialization functions

Synopsis

#define             LASSO_EXPORT
#define             LASSO_EXPORT_VAR
lasso_error_t       lasso_init                          (void);
lasso_error_t       lasso_shutdown                      (void);
enum                LassoCheckVersionMode;
int                 lasso_check_version                 (int major,
                                                         int minor,
                                                         int subminor,
                                                         LassoCheckVersionMode mode);
void                lasso_set_flag                      (char *flag);

Description

Details

LASSO_EXPORT

#        define LASSO_EXPORT __declspec(dllexport)

LASSO_EXPORT_VAR

#        define LASSO_EXPORT_VAR __declspec(dllexport) extern

lasso_init ()

lasso_error_t       lasso_init                          (void);

Initializes Lasso library.

Returns :

0 on success; or a negative value otherwise.

lasso_shutdown ()

lasso_error_t       lasso_shutdown                      (void);

Clean ups Lasso library.

Returns :

0 on success; or a negative value otherwise.

enum LassoCheckVersionMode

typedef enum {
	LASSO_CHECK_VERSION_EXACT = 0,
	LASSO_CHECK_VERSIONABI_COMPATIBLE,
	LASSO_CHECK_VERSION_NUMERIC
} LassoCheckVersionMode;

Lasso library version check mode.

LASSO_CHECK_VERSION_EXACT

version should match exactly

LASSO_CHECK_VERSIONABI_COMPATIBLE

version should be ABI compatible

LASSO_CHECK_VERSION_NUMERIC

version should be at least that number

lasso_check_version ()

int                 lasso_check_version                 (int major,
                                                         int minor,
                                                         int subminor,
                                                         LassoCheckVersionMode mode);

Checks if the loaded version of Lasso library could be used.

major :

major version numbe

minor :

minor version number

subminor :

subminor version number

mode :

version check mode

Returns :

1 if the loaded lasso library version is OK to use 0 if it is not; or a negative value if an error occurs.

lasso_set_flag ()

void                lasso_set_flag                      (char *flag);

Set a debugging flag. You can also use the environment variable LASSO_FLAG to get the same effect. LASSO_FLAG must contain flag name separated by spaces, commas, tabulations or colons.

flag :

a string representing a flag name, prefix with 'no-' to disable it.