IDS Peak comfortSDK, genericSDK, AFL, ICL, and IPL developer manuals are external documents.
Please contact us if you need these manuals.
The IDS peak library provides all API commands.
Initialization
Before you can use the IDS peak library, the library must be opened.
// initialize library
peak_status status = peak_Library_Init();
if (PEAK_ERROR(status)) { /* Error handling ... */ }
|
// include IDS peak
#include <peak/peak.hpp>
// ...
// initialize library
peak::Library::Initialize();
|
|
Note: With the switch to NuGet, the namespaces were renamed to follow C# conventions. You find migration tables in the ReadMe file of the respective NuGet package, see https://www.nuget.org/profiles/IDS_Imaging.
The following examples use the namespace as it was used up to IDS peak 2.19.
|
// initialize library
peak.Library.Initialize();
|
# include IDS peak
from ids_peak import ids_peak
# ...
# initialize library
ids_peak.Library.Initialize()
|
Getting the version
It is possible to query the library version.
uint32_t majorVersionNo = 0;
uint32_t minorVersionNo = 0;
uint32_t subMinorVersionNo = 0;
uint32_t patchVersionNo = 0;
// IDS peak version
peak_status status = peak_Library_GetVersion(&majorVersionNo, &minorVersionNo, &subMinorVersionNo, &patchVersionNo);
if (PEAK_ERROR(status)) { /* Error handling ... */ }
printf("IDS peak version No: %i.%i.%i (Patch %i)\n", majorVersionNo, minorVersionNo, subMinorVersionNo, patchVersionNo);
|
// IDS peak version
auto peakVersion = peak::Library::Version();
|
|
Note: With the switch to NuGet, the namespaces were renamed to follow C# conventions. You find migration tables in the ReadMe file of the respective NuGet package, see https://www.nuget.org/profiles/IDS_Imaging.
The following examples use the namespace as it was used up to IDS peak 2.19.
|
// IDS peak version
var peakVersion = peak.Library.Version();
|
# IDS peak version
peakVersion = ids_peak.Library.Version()
|
Closing the library
Before closing an application with IDS peak, the library must be closed.
// close library before exiting program
peak_status status = peak_Library_Exit();
if (PEAK_ERROR(status)) { /* Error handling ... */ }
|
// close library before exiting program
peak::Library::Close();
|
|
Note: With the switch to NuGet, the namespaces were renamed to follow C# conventions. You find migration tables in the ReadMe file of the respective NuGet package, see https://www.nuget.org/profiles/IDS_Imaging.
The following examples use the namespace as it was used up to IDS peak 2.19.
|
// close library before exiting program
peak.Library.Close();
|
# close library before exiting program
ids_peak.Library.Close()
|
