Core Library Functions

Data Structures

struct   IC4_INIT_CONFIG

The library initialization config structure. More...

Enumerations

enum   IC4_LOG_LEVEL {
  IC4_LOG_OFF , IC4_LOG_ERROR , IC4_LOG_WARN , IC4_LOG_INFO ,
  IC4_LOG_DEBUG , IC4_LOG_TRACE
}

Defines the possible library log levels. More...
enum  IC4_LOG_TARGET_FLAGS {
  IC4_LOGTARGET_DISABLE = 0 , IC4_LOGTARGET_STDOUT = 1 , IC4_LOGTARGET_STDERR = 2 , IC4_LOGTARGET_FILE = 4 ,
  IC4_LOGTARGET_WINDEBUG = 8
}

Defines the possible log targets. More...
enum  IC4_VERSION_INFO_FLAGS {
  IC4_VERSION_INFO_DEFAULT = 0x0 , IC4_VERSION_INFO_ALL = 0x1 , IC4_VERSION_INFO_IC4 = 0x2 , IC4_VERSION_INFO_DRIVER = 0x4 ,
  IC4_VERSION_INFO_PLUGINS = 0x8
}

Contains retrievable version descriptions. More...

Functions

bool  ic4_init_library (const struct IC4_INIT_CONFIG *init_config)

Initializes the IC Imaging Control 4 C Library.

void  ic4_exit_library ()

Un-initializes the library.
bool  ic4_get_version_info (char *str, size_t *size, enum IC4_VERSION_INFO_FLAGS flags)

Retrieve version information description string.

Detailed Description

Enumeration Type Documentation

◆ IC4_LOG_LEVEL

enum IC4_LOG_LEVEL

Defines the possible library log levels.

Enumerator
IC4_LOG_OFF 

Disable logging.

IC4_LOG_ERROR 

Log only errors.

IC4_LOG_WARN 

Log warnings and above.

IC4_LOG_INFO 

Log info and above.

IC4_LOG_DEBUG 

Log debug and above.

IC4_LOG_TRACE 

Log trace and above.

◆ IC4_LOG_TARGET_FLAGS

enum IC4_LOG_TARGET_FLAGS

Defines the possible log targets.

Enumerator
IC4_LOGTARGET_DISABLE 

Disable logging.

IC4_LOGTARGET_STDOUT 

Log to stdout.

IC4_LOGTARGET_STDERR 

Log to stderr.

IC4_LOGTARGET_FILE 

Log to a file specified by IC4_INIT_CONFIG::log_file.

IC4_LOGTARGET_WINDEBUG 

Log using OutputDebugString (Windows only)

◆ IC4_VERSION_INFO_FLAGS

enum IC4_VERSION_INFO_FLAGS

Contains retrievable version descriptions.

Enumerator
IC4_VERSION_INFO_DEFAULT 

Give the most useful information.

IC4_VERSION_INFO_ALL 

Give as much information as possible.

IC4_VERSION_INFO_IC4 

Information about IC4 core libraries.

IC4_VERSION_INFO_DRIVER 

Information about TIS GenTL providers.

IC4_VERSION_INFO_PLUGINS 

Information about IC4 plugins.

Function Documentation

◆ ic4_exit_library()

void ic4_exit_library ( )

Un-initializes the library.

Every successful call to ic4_init_library should be balanced by a matching call to ic4_exit_library before unloading the library DLL.

◆ ic4_get_version_info()

bool ic4_get_version_info ( char *  str,
size_t *  size,
enum IC4_VERSION_INFO_FLAGS  flags 
)

Retrieve version information description string.

Parameters
[out]strPointer to a character array to receive an error message.
[in,out]sizeSize of str buffer
[in]flagsWhat version information to retrieve
Returns
true on success

◆ ic4_init_library()

bool ic4_init_library ( const struct IC4_INIT_CONFIG *  init_config)

Initializes the IC Imaging Control 4 C Library.

ic4_init_library must be called before any other library function.

Parameters
init_configA structure configuring library settings, e.g. the log level.
Returns
true on success, otherwise false.