IDS peak ICV v1.6.0
Loading...
Searching...
No Matches
Library

Functions

void Init ()
 Initializes the IDS peak ICV library.
 
void Exit ()
 Deinitializes the IDS peak ICV library.
 
peak::common::Version Version ()
 

Detailed Description

Library runtime management.

Provides global control and initialization functions.

Function Documentation

◆ Exit()

void Exit ( )
inline

Deinitializes the IDS peak ICV library.

This function should be called when no function of the library is needed anymore. It releases all allocated memory and destroys all handles along with their associated resources.

Calls to Init and Exit are reference counted, so you have to call Exit as many times as you have called Init.

After the library has been deinitialized, its functions (except for Init) will not be operable until Init is called again.

Note
Calling any other function (except Init) after calling Exit will result in an InvalidConfigurationException.
Exceptions
InvalidConfigurationExceptionif the library is not initialized.
Since
ids_peak_icv 1.0

◆ Init()

void Init ( )
inline

Initializes the IDS peak ICV library.

This function must be called prior to any other function call, otherwise no IDS peak ICV function is operable.

The function may be called multiple times from a single client process, but note that for each call there has to be a corresponding call to Exit when closing the library.

Note
Calling any other function before Init will result in an InvalidConfigurationException.
Since
ids_peak_icv 1.0

◆ Version()

peak::common::Version Version ( )
inline
Note
This function can be used even if the library is not initialized.