peak_backend.h File Reference

#include <peak/backend/peak_dll_defines.h>
#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Classes
struct	PEAK_DEVICE_RECONNECT_INFORMATION

Macros
#define	PEAK_NO_DISCARD
#define	PEAK_MAYBE_UNUSED
#define	PEAK_C_API   PEAK_PUBLIC PEAK_RETURN_CODE PEAK_CALL_CONV

Typedefs
typedef int8_t	PEAK_BOOL8
typedef int32_t	PEAK_ACQUISITION_START_MODE
typedef int32_t	PEAK_ACQUISITION_STOP_MODE
typedef int32_t	PEAK_BUFFER_PART_TYPE
typedef int32_t	PEAK_BUFFER_PAYLOAD_TYPE
typedef int32_t	PEAK_CHARACTER_ENCODING
typedef int32_t	PEAK_DATA_STREAM_FLUSH_MODE
typedef int32_t	PEAK_DEVICE_ACCESS_STATUS
typedef int32_t	PEAK_DEVICE_ACCESS_TYPE
typedef int32_t	PEAK_DEVICE_INFORMATION_ROLE
typedef int32_t	PEAK_ENDIANNESS
typedef int32_t	PEAK_EVENT_TYPE
typedef int32_t	PEAK_FIRMWARE_UPDATE_PERSISTENCE
typedef int32_t	PEAK_FIRMWARE_UPDATE_STEP
typedef int32_t	PEAK_FIRMWARE_UPDATE_VERSION_STYLE
typedef int32_t	PEAK_NODE_ACCESS_STATUS
typedef int32_t	PEAK_NODE_CACHING_MODE
typedef int32_t	PEAK_NODE_CACHE_USE_POLICY
typedef int32_t	PEAK_NODE_DISPLAY_NOTATION
typedef int32_t	PEAK_NODE_INCREMENT_TYPE
typedef int32_t	PEAK_NODE_NAMESPACE
typedef int32_t	PEAK_NODE_REPRESENTATION
typedef int32_t	PEAK_NODE_TYPE
typedef int32_t	PEAK_NODE_VISIBILITY
typedef int32_t	PEAK_PIXEL_FORMAT_NAMESPACE
typedef int32_t	PEAK_PORT_URL_SCHEME
typedef int32_t	PEAK_RETURN_CODE
typedef struct PEAK_PRODUCER_LIBRARY *	PEAK_PRODUCER_LIBRARY_HANDLE
typedef struct PEAK_SYSTEM_DESCRIPTOR *	PEAK_SYSTEM_DESCRIPTOR_HANDLE
typedef struct PEAK_SYSTEM *	PEAK_SYSTEM_HANDLE
typedef struct PEAK_INTERFACE_DESCRIPTOR *	PEAK_INTERFACE_DESCRIPTOR_HANDLE
typedef struct PEAK_INTERFACE *	PEAK_INTERFACE_HANDLE
typedef struct PEAK_DEVICE_DESCRIPTOR *	PEAK_DEVICE_DESCRIPTOR_HANDLE
typedef struct PEAK_DEVICE *	PEAK_DEVICE_HANDLE
typedef struct PEAK_REMOTE_DEVICE *	PEAK_REMOTE_DEVICE_HANDLE
typedef struct PEAK_DATA_STREAM_DESCRIPTOR *	PEAK_DATA_STREAM_DESCRIPTOR_HANDLE
typedef struct PEAK_DATA_STREAM *	PEAK_DATA_STREAM_HANDLE
typedef struct PEAK_BUFFER *	PEAK_BUFFER_HANDLE
typedef struct PEAK_BUFFER_CHUNK *	PEAK_BUFFER_CHUNK_HANDLE
typedef struct PEAK_BUFFER_PART *	PEAK_BUFFER_PART_HANDLE
typedef struct PEAK_MODULE_DESCRIPTOR *	PEAK_MODULE_DESCRIPTOR_HANDLE
typedef struct PEAK_MODULE *	PEAK_MODULE_HANDLE
typedef struct PEAK_NODE_MAP *	PEAK_NODE_MAP_HANDLE
typedef struct PEAK_NODE *	PEAK_NODE_HANDLE
typedef struct PEAK_INTEGER_NODE *	PEAK_INTEGER_NODE_HANDLE
typedef struct PEAK_BOOLEAN_NODE *	PEAK_BOOLEAN_NODE_HANDLE
typedef struct PEAK_COMMAND_NODE *	PEAK_COMMAND_NODE_HANDLE
typedef struct PEAK_FLOAT_NODE *	PEAK_FLOAT_NODE_HANDLE
typedef struct PEAK_STRING_NODE *	PEAK_STRING_NODE_HANDLE
typedef struct PEAK_REGISTER_NODE *	PEAK_REGISTER_NODE_HANDLE
typedef struct PEAK_CATEGORY_NODE *	PEAK_CATEGORY_NODE_HANDLE
typedef struct PEAK_ENUMERATION_NODE *	PEAK_ENUMERATION_NODE_HANDLE
typedef struct PEAK_ENUMERATION_ENTRY_NODE *	PEAK_ENUMERATION_ENTRY_NODE_HANDLE
typedef struct PEAK_PORT *	PEAK_PORT_HANDLE
typedef struct PEAK_PORT_URL *	PEAK_PORT_URL_HANDLE
typedef struct PEAK_EVENT_SUPPORTING_MODULE *	PEAK_EVENT_SUPPORTING_MODULE_HANDLE
typedef struct PEAK_EVENT_CONTROLLER *	PEAK_EVENT_CONTROLLER_HANDLE
typedef struct PEAK_EVENT *	PEAK_EVENT_HANDLE
typedef struct PEAK_FILE_ADAPTER *	PEAK_FILE_ADAPTER_HANDLE
typedef struct PEAK_FIRMWARE_UPDATER *	PEAK_FIRMWARE_UPDATER_HANDLE
typedef struct PEAK_FIRMWARE_UPDATE_INFORMATION *	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE
typedef struct PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER *	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_INTERFACE_FOUND_CALLBACK) (PEAK_INTERFACE_DESCRIPTOR_HANDLE foundInterface, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_INTERFACE_LOST_CALLBACK) (const char *lostInterfaceId, size_t lostInterfaceIdSize, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_INTERFACE_LIST_CHANGED_CALLBACK) (void *context)
typedef PEAK_INTERFACE_FOUND_CALLBACK *	PEAK_INTERFACE_FOUND_CALLBACK_HANDLE
typedef PEAK_INTERFACE_LOST_CALLBACK *	PEAK_INTERFACE_LOST_CALLBACK_HANDLE
typedef PEAK_INTERFACE_LIST_CHANGED_CALLBACK *	PEAK_INTERFACE_LIST_CHANGED_CALLBACK_HANDLE
typedef uint32_t	PEAK_DEVICE_RECONNECT_ERROR_FLAGS
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_FOUND_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE foundDevice, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_RECONNECTED_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE reconnectedDevice, PEAK_DEVICE_RECONNECT_INFORMATION reconnectInformation, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_LOST_CALLBACK) (const char *lostDeviceId, size_t lostDeviceIdSize, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_DISCONNETED_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE disconnectedDevice, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_LIST_CHANGED_CALLBACK) (void *context)
typedef PEAK_DEVICE_FOUND_CALLBACK *	PEAK_DEVICE_FOUND_CALLBACK_HANDLE
typedef PEAK_DEVICE_RECONNECTED_CALLBACK *	PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE
typedef PEAK_DEVICE_DISCONNETED_CALLBACK *	PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE
typedef PEAK_DEVICE_LOST_CALLBACK *	PEAK_DEVICE_LOST_CALLBACK_HANDLE
typedef PEAK_DEVICE_LIST_CHANGED_CALLBACK *	PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_BUFFER_REVOCATION_CALLBACK) (void *buffer, void *userPtr, void *context)
typedef void(PEAK_CALL_CONV *	PEAK_NODE_CHANGED_CALLBACK) (PEAK_NODE_HANDLE changedNode, void *context)
typedef PEAK_NODE_CHANGED_CALLBACK *	PEAK_NODE_CHANGED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK) (const PEAK_DEVICE_INFORMATION_ROLE *changedRoles, size_t changedRolesSize, void *context)
typedef PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK *	PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK) (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, uint32_t estimatedDuration_ms, void *context)
typedef PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK *	PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, uint32_t estimatedDuration_ms, const char *description, size_t descriptionSize, void *context)
typedef PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK *	PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, double progressPercentage, void *context)
typedef PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK *	PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, void *context)
typedef PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK *	PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK) (void *context)
typedef PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK *	PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE
typedef void(PEAK_CALL_CONV *	PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK) (const char *errorDescription, size_t errorDescriptionSize, void *context)
typedef PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK *	PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE

Enumerations
enum	PEAK_ACQUISITION_START_MODE_t {   PEAK_ACQUISITION_START_MODE_DEFAULT = 0 ,   PEAK_ACQUISITION_START_MODE_CUSTOM = 1000 }
enum	PEAK_ACQUISITION_STOP_MODE_t {   PEAK_ACQUISITION_STOP_MODE_DEFAULT = 0 ,   PEAK_ACQUISITION_STOP_MODE_KILL ,   PEAK_ACQUISITION_STOP_MODE_CUSTOM = 1000 }
enum	PEAK_BUFFER_PART_TYPE_t {   PEAK_BUFFER_PART_TYPE_UNKNOWN = 0 ,   PEAK_BUFFER_PART_TYPE_IMAGE_2D ,   PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_2D ,   PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_2D ,   PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_2D ,   PEAK_BUFFER_PART_TYPE_IMAGE_3D ,   PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_3D ,   PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_3D ,   PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_3D ,   PEAK_BUFFER_PART_TYPE_CONFIDENCE_MAP ,   PEAK_BUFFER_PART_TYPE_CUSTOM = 1000 }
enum	PEAK_BUFFER_PAYLOAD_TYPE_t {   PEAK_BUFFER_PAYLOAD_TYPE_UNKNOWN = 0 ,   PEAK_BUFFER_PAYLOAD_TYPE_IMAGE ,   PEAK_BUFFER_PAYLOAD_TYPE_RAW_DATA ,   PEAK_BUFFER_PAYLOAD_TYPE_FILE ,   PEAK_BUFFER_PAYLOAD_TYPE_CHUNK ,   PEAK_BUFFER_PAYLOAD_TYPE_JPEG ,   PEAK_BUFFER_PAYLOAD_TYPE_JPEG_2000 ,   PEAK_BUFFER_PAYLOAD_TYPE_H264 ,   PEAK_BUFFER_PAYLOAD_TYPE_CHUNK_ONLY ,   PEAK_BUFFER_PAYLOAD_TYPE_DEVICE_SPECIFIC ,   PEAK_BUFFER_PAYLOAD_TYPE_MULTI_PART ,   PEAK_BUFFER_PAYLOAD_TYPE_CUSTOM = 1000 }
enum	PEAK_CHARACTER_ENCODING_t {   PEAK_CHARACTER_ENCODING_ASCII = 0 ,   PEAK_CHARACTER_ENCODING_UTF8 }
enum	PEAK_DATA_STREAM_FLUSH_MODE_t {   PEAK_DATA_STREAM_FLUSH_MODE_INPUT_POOL_TO_OUTPUT_QUEUE = 0 ,   PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_OUTPUT_QUEUE ,   PEAK_DATA_STREAM_FLUSH_MODE_ALL_TO_INPUT_POOL ,   PEAK_DATA_STREAM_FLUSH_MODE_UNQUEUED_TO_INPUT_POOL ,   PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_ALL ,   PEAK_DATA_STREAM_FLUSH_MODE_CUSTOM = 1000 }
enum	PEAK_DEVICE_ACCESS_STATUS_t {   PEAK_DEVICE_ACCESS_STATUS_READ_WRITE = 1 ,   PEAK_DEVICE_ACCESS_STATUS_READ_ONLY ,   PEAK_DEVICE_ACCESS_STATUS_NO_ACCESS ,   PEAK_DEVICE_ACCESS_STATUS_BUSY ,   PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_WRITE ,   PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_ONLY ,   PEAK_DEVICE_ACCESS_STATUS_CUSTOM = 1000 }
enum	PEAK_DEVICE_ACCESS_TYPE_t {   PEAK_DEVICE_ACCESS_TYPE_READ_ONLY = 2 ,   PEAK_DEVICE_ACCESS_TYPE_CONTROL ,   PEAK_DEVICE_ACCESS_TYPE_EXCLUSIVE ,   PEAK_DEVICE_ACCESS_TYPE_CUSTOM = 1000 }
enum	PEAK_DEVICE_INFORMATION_ROLE_t {   PEAK_DEVICE_INFORMATION_ROLE_ID = 0 ,   PEAK_DEVICE_INFORMATION_ROLE_VENDOR_NAME ,   PEAK_DEVICE_INFORMATION_ROLE_MODEL_NAME ,   PEAK_DEVICE_INFORMATION_ROLE_TL_TYPE ,   PEAK_DEVICE_INFORMATION_ROLE_DISPLAY_NAME ,   PEAK_DEVICE_INFORMATION_ROLE_ACCESS_STATUS ,   PEAK_DEVICE_INFORMATION_ROLE_USER_DEFINED_NAME ,   PEAK_DEVICE_INFORMATION_ROLE_SERIAL_NUMBER ,   PEAK_DEVICE_INFORMATION_ROLE_VERSION ,   PEAK_DEVICE_INFORMATION_ROLE_TIMESTAMP_TICK_FREQUENCY ,   PEAK_DEVICE_INFORMATION_ROLE_CUSTOM = 1000 }
enum	PEAK_ENDIANNESS_t {   PEAK_ENDIANNESS_UNKNOWN = 0 ,   PEAK_ENDIANNESS_LITTLE ,   PEAK_ENDIANNESS_BIG }
enum	PEAK_EVENT_TYPE_t {   PEAK_EVENT_TYPE_ERROR = 0 ,   PEAK_EVENT_TYPE_FEATURE_INVALIDATE = 2 ,   PEAK_EVENT_TYPE_FEATURE_CHANGE ,   PEAK_EVENT_TYPE_REMOTE_DEVICE ,   PEAK_EVENT_TYPE_MODULE ,   PEAK_EVENT_TYPE_FEATURE_CUSTOM = 1000 }
enum	PEAK_FIRMWARE_UPDATE_PERSISTENCE_t {   PEAK_FIRMWARE_UPDATE_PERSISTENCE_NONE = 0 ,   PEAK_FIRMWARE_UPDATE_PERSISTENCE_FULL }
enum	PEAK_FIRMWARE_UPDATE_STEP_t {   PEAK_FIRMWARE_UPDATE_STEP_CHECK_PRECONDITIONS = 0 ,   PEAK_FIRMWARE_UPDATE_STEP_ACQUIRE_UPDATE_DATA ,   PEAK_FIRMWARE_UPDATE_STEP_WRITE_FEATURE ,   PEAK_FIRMWARE_UPDATE_STEP_EXECUTE_FEATURE ,   PEAK_FIRMWARE_UPDATE_STEP_ASSERT_FEATURE ,   PEAK_FIRMWARE_UPDATE_STEP_UPLOAD_FILE ,   PEAK_FIRMWARE_UPDATE_STEP_RESET_DEVICE }
enum	PEAK_FIRMWARE_UPDATE_VERSION_STYLE_t {   PEAK_FIRMWARE_UPDATE_VERSION_STYLE_DOTTED = 0 ,   PEAK_FIRMWARE_UPDATE_VERSION_STYLE_SEMANTIC }
enum	PEAK_NODE_ACCESS_STATUS_t {   PEAK_NODE_ACCESS_STATUS_NOT_IMPLEMENTED = 0 ,   PEAK_NODE_ACCESS_STATUS_NOT_AVAILABLE ,   PEAK_NODE_ACCESS_STATUS_WRITE_ONLY ,   PEAK_NODE_ACCESS_STATUS_READ_ONLY ,   PEAK_NODE_ACCESS_STATUS_READ_WRITE }
enum	PEAK_NODE_CACHING_MODE_t {   PEAK_NODE_CACHING_MODE_NO_CACHE = 0 ,   PEAK_NODE_CACHING_MODE_WRITE_THROUGH ,   PEAK_NODE_CACHING_MODE_WRITE_AROUND }
enum	PEAK_NODE_CACHE_USE_POLICY_t {   PEAK_NODE_CACHE_USE_POLICY_USE_CACHE = 0 ,   PEAK_NODE_CACHE_USE_POLICY_IGNORE_CACHE }
enum	PEAK_NODE_DISPLAY_NOTATION_t {   PEAK_NODE_DISPLAY_NOTATION_AUTOMATIC = 0 ,   PEAK_NODE_DISPLAY_NOTATION_FIXED ,   PEAK_NODE_DISPLAY_NOTATION_SCIENTIFIC }
enum	PEAK_NODE_INCREMENT_TYPE_t {   PEAK_NODE_INCREMENT_TYPE_NO_INCREMENT = 0 ,   PEAK_NODE_INCREMENT_TYPE_FIXED_INCREMENT ,   PEAK_NODE_INCREMENT_TYPE_LIST_INCREMENT }
enum	PEAK_NODE_NAMESPACE_t {   PEAK_NODE_NAMESPACE_CUSTOM = 0 ,   PEAK_NODE_NAMESPACE_STANDARD }
enum	PEAK_NODE_REPRESENTATION_t {   PEAK_NODE_REPRESENTATION_LINEAR = 0 ,   PEAK_NODE_REPRESENTATION_LOGARITHMIC ,   PEAK_NODE_REPRESENTATION_BOOLEAN ,   PEAK_NODE_REPRESENTATION_PURE_NUMBER ,   PEAK_NODE_REPRESENTATION_HEX_NUMBER ,   PEAK_NODE_REPRESENTATION_IP4_ADDRESS ,   PEAK_NODE_REPRESENTATION_MAC_ADDRESS }
enum	PEAK_NODE_TYPE_t {   PEAK_NODE_TYPE_INTEGER = 0 ,   PEAK_NODE_TYPE_BOOLEAN ,   PEAK_NODE_TYPE_COMMAND ,   PEAK_NODE_TYPE_FLOAT ,   PEAK_NODE_TYPE_STRING ,   PEAK_NODE_TYPE_REGISTER ,   PEAK_NODE_TYPE_CATEGORY ,   PEAK_NODE_TYPE_ENUMERATION ,   PEAK_NODE_TYPE_ENUMERATION_ENTRY }
enum	PEAK_NODE_VISIBILITY_t {   PEAK_NODE_VISIBILITY_BEGINNER = 0 ,   PEAK_NODE_VISIBILITY_EXPERT ,   PEAK_NODE_VISIBILITY_GURU ,   PEAK_NODE_VISIBILITY_INVISIBLE }
enum	PEAK_PIXEL_FORMAT_NAMESPACE_t {   PEAK_PIXEL_FORMAT_NAMESPACE_GEV = 1 ,   PEAK_PIXEL_FORMAT_NAMESPACE_IIDC ,   PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_16_BIT ,   PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_32_BIT ,   PEAK_PIXEL_FORMAT_NAMESPACE_CUSTOM = 1000 }
enum	PEAK_PORT_URL_SCHEME_t {   PEAK_PORT_URL_SCHEME_LOCAL = 0 ,   PEAK_PORT_URL_SCHEME_HTTP ,   PEAK_PORT_URL_SCHEME_FILE ,   PEAK_PORT_URL_SCHEME_CUSTOM = 1000 }
enum	PEAK_RETURN_CODE_t {   PEAK_RETURN_CODE_SUCCESS = 0 ,   PEAK_RETURN_CODE_ERROR ,   PEAK_RETURN_CODE_NOT_INITIALIZED ,   PEAK_RETURN_CODE_ABORTED ,   PEAK_RETURN_CODE_BAD_ACCESS ,   PEAK_RETURN_CODE_BAD_ALLOC ,   PEAK_RETURN_CODE_BUFFER_TOO_SMALL ,   PEAK_RETURN_CODE_INVALID_ADDRESS ,   PEAK_RETURN_CODE_INVALID_ARGUMENT ,   PEAK_RETURN_CODE_INVALID_CAST ,   PEAK_RETURN_CODE_INVALID_HANDLE ,   PEAK_RETURN_CODE_NOT_FOUND ,   PEAK_RETURN_CODE_OUT_OF_RANGE ,   PEAK_RETURN_CODE_TIMEOUT ,   PEAK_RETURN_CODE_NOT_AVAILABLE ,   PEAK_RETURN_CODE_NOT_IMPLEMENTED ,   PEAK_RETURN_CODE_CTI_LOADING_ERROR ,   PEAK_RETURN_CODE_IO ,   PEAK_RETURN_CODE_NO_DATA }
enum	PEAK_DEVICE_RECONNECT_ERROR_t {   PEAK_DEVICE_RECONNECT_OPERATION_NO_ERROR = 0x0 ,   PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_ERROR = 0x1000000 ,   PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_PAYLOAD_SIZE_LARGER_THAN_BUFFERS = 0x1000001 ,   PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_CONFIGURATION_RESTORE_ERROR = 0x2000000 }

Functions
PEAK_C_API	PEAK_Library_Initialize ()
	Initializes the IDS peak genericAPI library.
PEAK_C_API	PEAK_Library_Close ()
	Closes the IDS peak genericAPI library and cleans up any resources that are still in use.
PEAK_C_API	PEAK_Library_IsInitialized (PEAK_BOOL8 *isInitialized)
	Checks if the IDS peak genericAPI library is initialized.
PEAK_C_API	PEAK_Library_GetVersionMajor (uint32_t *libraryVersionMajor)
	Asks for the major component of the library version.
PEAK_C_API	PEAK_Library_GetVersionMinor (uint32_t *libraryVersionMinor)
	Asks for the minor component of the library version.
PEAK_C_API	PEAK_Library_GetVersionSubminor (uint32_t *libraryVersionSubminor)
	Asks for the subminor component of the library version.
PEAK_C_API	PEAK_Library_GetLastError (PEAK_RETURN_CODE *lastErrorCode, char *lastErrorDescription, size_t *lastErrorDescriptionSize)
	Queries the last error.
PEAK_C_API	PEAK_EnvironmentInspector_UpdateCTIPaths ()
	Collects the paths to the CTIs installed on the system.
PEAK_C_API	PEAK_EnvironmentInspector_GetNumCTIPaths (size_t *numCtiPaths)
	Asks for the number of CTI paths.
PEAK_C_API	PEAK_EnvironmentInspector_GetCTIPath (size_t index, char *ctiPath, size_t *ctiPathSize)
	Asks for the CTI path with the given index.
PEAK_C_API	PEAK_ProducerLibrary_Construct (const char *ctiPath, size_t ctiPathSize, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
	Creates a producer library.
PEAK_C_API	PEAK_ProducerLibrary_GetKey (PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, char *key, size_t *keySize)
	Asks the given producer library for its key.
PEAK_C_API	PEAK_ProducerLibrary_GetSystem (PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, PEAK_SYSTEM_DESCRIPTOR_HANDLE *systemDescriptorHandle)
	Asks the given producer library for its system descriptor.
PEAK_C_API	PEAK_ProducerLibrary_Destruct (PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle)
	Destroys the given producer library.
PEAK_C_API	PEAK_SystemDescriptor_ToModuleDescriptor (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
	Casts the given system descriptor to a module descriptor.
PEAK_C_API	PEAK_SystemDescriptor_GetKey (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *key, size_t *keySize)
	Asks the given system descriptor for its key.
PEAK_C_API	PEAK_SystemDescriptor_GetInfo (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given system descriptor for an information based on a specific command.
PEAK_C_API	PEAK_SystemDescriptor_GetDisplayName (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *displayName, size_t *displayNameSize)
	Asks the given system descriptor for its display name.
PEAK_C_API	PEAK_SystemDescriptor_GetVendorName (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *vendorName, size_t *vendorNameSize)
	Asks the given system descriptor for its vendor name.
PEAK_C_API	PEAK_SystemDescriptor_GetModelName (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *modelName, size_t *modelNameSize)
	Asks the given system descriptor for its model name.
PEAK_C_API	PEAK_SystemDescriptor_GetVersion (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *version, size_t *versionSize)
	Asks the given system descriptor for its version.
PEAK_C_API	PEAK_SystemDescriptor_GetTLType (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *tlType, size_t *tlTypeSize)
	Asks the given system descriptor for its TL type.
PEAK_C_API	PEAK_SystemDescriptor_GetCTIFileName (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *ctiFileName, size_t *ctiFileNameSize)
	Asks the given system descriptor for its parent CTI's file name.
PEAK_C_API	PEAK_SystemDescriptor_GetCTIFullPath (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *ctiFullPath, size_t *ctiFullPathSize)
	Asks the given system descriptor for its parent CTI's full path.
PEAK_C_API	PEAK_SystemDescriptor_GetGenTLVersionMajor (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t *gentlVersionMajor)
	Asks the given system descriptor for the major component of its GenTL version.
PEAK_C_API	PEAK_SystemDescriptor_GetGenTLVersionMinor (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t *gentlVersionMinor)
	Asks the given system descriptor for the minor component of its GenTL version.
PEAK_C_API	PEAK_SystemDescriptor_GetCharacterEncoding (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_CHARACTER_ENCODING *characterEncoding)
	Asks the given system descriptor for its character encoding.
PEAK_C_API	PEAK_SystemDescriptor_GetParentLibrary (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
	Asks the given system descriptor for its parent library.
PEAK_C_API	PEAK_SystemDescriptor_OpenSystem (PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_SYSTEM_HANDLE *systemHandle)
	Opens the system being associated with the given system descriptor.
PEAK_C_API	PEAK_System_ToModule (PEAK_SYSTEM_HANDLE systemHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given system to a module.
PEAK_C_API	PEAK_System_ToEventSupportingModule (PEAK_SYSTEM_HANDLE systemHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
	Casts the given system to an event-supporting module.
PEAK_C_API	PEAK_System_GetKey (PEAK_SYSTEM_HANDLE systemHandle, char *key, size_t *keySize)
	Asks the given system for its key.
PEAK_C_API	PEAK_System_GetInfo (PEAK_SYSTEM_HANDLE systemHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given system for an information based on a specific command.
PEAK_C_API	PEAK_System_GetID (PEAK_SYSTEM_HANDLE systemHandle, char *id, size_t *idSize)
	Asks the given system for its ID.
PEAK_C_API	PEAK_System_GetDisplayName (PEAK_SYSTEM_HANDLE systemHandle, char *displayName, size_t *displayNameSize)
	Asks the given system for its display name.
PEAK_C_API	PEAK_System_GetVendorName (PEAK_SYSTEM_HANDLE systemHandle, char *vendorName, size_t *vendorNameSize)
	Asks the given system for its vendor name.
PEAK_C_API	PEAK_System_GetModelName (PEAK_SYSTEM_HANDLE systemHandle, char *modelName, size_t *modelNameSize)
	Asks the given system for its model name.
PEAK_C_API	PEAK_System_GetVersion (PEAK_SYSTEM_HANDLE systemHandle, char *version, size_t *versionSize)
	Asks the given system for its version.
PEAK_C_API	PEAK_System_GetTLType (PEAK_SYSTEM_HANDLE systemHandle, char *tlType, size_t *tlTypeSize)
	Asks the given system for its TL type.
PEAK_C_API	PEAK_System_GetCTIFileName (PEAK_SYSTEM_HANDLE systemHandle, char *ctiFileName, size_t *ctiFileNameSize)
	Asks the given system for its parent CTI's file name.
PEAK_C_API	PEAK_System_GetCTIFullPath (PEAK_SYSTEM_HANDLE systemHandle, char *ctiFullPath, size_t *ctiFullPathSize)
	Asks the given system for its parent CTI's full path.
PEAK_C_API	PEAK_System_GetGenTLVersionMajor (PEAK_SYSTEM_HANDLE systemHandle, uint32_t *gentlVersionMajor)
	Asks the given system for the major component of its GenTL version.
PEAK_C_API	PEAK_System_GetGenTLVersionMinor (PEAK_SYSTEM_HANDLE systemHandle, uint32_t *gentlVersionMinor)
	Asks the given system for the minor component of its GenTL version.
PEAK_C_API	PEAK_System_GetCharacterEncoding (PEAK_SYSTEM_HANDLE systemHandle, PEAK_CHARACTER_ENCODING *characterEncoding)
	Asks the given system for its character encoding.
PEAK_C_API	PEAK_System_GetParentLibrary (PEAK_SYSTEM_HANDLE systemHandle, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
	Asks the given system for its parent library.
PEAK_C_API	PEAK_System_UpdateInterfaces (PEAK_SYSTEM_HANDLE systemHandle, uint64_t timeout_ms)
	Tells the given system to update its interfaces with the given timeout.
PEAK_C_API	PEAK_System_GetNumInterfaces (PEAK_SYSTEM_HANDLE systemHandle, size_t *numInterfaces)
	Asks the given system for its number of interfaces.
PEAK_C_API	PEAK_System_GetInterface (PEAK_SYSTEM_HANDLE systemHandle, size_t index, PEAK_INTERFACE_DESCRIPTOR_HANDLE *interfaceDescriptorHandle)
	Asks the given system for the interface descriptor with the given index.
PEAK_C_API	PEAK_System_RegisterInterfaceFoundCallback (PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_FOUND_CALLBACK callback, void *callbackContext, PEAK_INTERFACE_FOUND_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a found interface at the given system.
PEAK_C_API	PEAK_System_UnregisterInterfaceFoundCallback (PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_FOUND_CALLBACK_HANDLE callbackHandle)
	Unregisters the interface-found callback with the given handle from the given system.
PEAK_C_API	PEAK_System_RegisterInterfaceLostCallback (PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_LOST_CALLBACK callback, void *callbackContext, PEAK_INTERFACE_LOST_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a lost interface at the given system.
PEAK_C_API	PEAK_System_UnregisterInterfaceLostCallback (PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_LOST_CALLBACK_HANDLE callbackHandle)
	Unregisters the interface-lost callback with the given handle from the given system.
PEAK_C_API	PEAK_System_Destruct (PEAK_SYSTEM_HANDLE systemHandle)
	Destroys the given system.
PEAK_C_API	PEAK_InterfaceDescriptor_ToModuleDescriptor (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
	Casts the given interface descriptor to a module descriptor.
PEAK_C_API	PEAK_InterfaceDescriptor_GetKey (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *key, size_t *keySize)
	Asks the given interface descriptor for its key.
PEAK_C_API	PEAK_InterfaceDescriptor_GetInfo (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given interface descriptor for an information based on a specific command.
PEAK_C_API	PEAK_InterfaceDescriptor_GetDisplayName (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *displayName, size_t *displayNameSize)
	Asks the given interface descriptor for its display name.
PEAK_C_API	PEAK_InterfaceDescriptor_GetTLType (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *tlType, size_t *tlTypeSize)
	Asks the given interface descriptor for its TL type.
PEAK_C_API	PEAK_InterfaceDescriptor_GetParentSystem (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_SYSTEM_HANDLE *systemHandle)
	Asks the given interface descriptor for its parent system.
PEAK_C_API	PEAK_InterfaceDescriptor_OpenInterface (PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
	Opens the interface being associated with the given interface descriptor.
PEAK_C_API	PEAK_Interface_ToModule (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given interface to a module.
PEAK_C_API	PEAK_Interface_ToEventSupportingModule (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
	Casts the given interface to an event-supporting module.
PEAK_C_API	PEAK_Interface_GetKey (PEAK_INTERFACE_HANDLE interfaceHandle, char *key, size_t *keySize)
	Asks the given interface for its key.
PEAK_C_API	PEAK_Interface_GetInfo (PEAK_INTERFACE_HANDLE interfaceHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given interface for an information based on a specific command.
PEAK_C_API	PEAK_Interface_GetID (PEAK_INTERFACE_HANDLE interfaceHandle, char *id, size_t *idSize)
	Asks the given interface for its ID.
PEAK_C_API	PEAK_Interface_GetDisplayName (PEAK_INTERFACE_HANDLE interfaceHandle, char *displayName, size_t *displayNameSize)
	Asks the given interface for its display name.
PEAK_C_API	PEAK_Interface_GetTLType (PEAK_INTERFACE_HANDLE interfaceHandle, char *tlType, size_t *tlTypeSize)
	Asks the given interface for its TL type.
PEAK_C_API	PEAK_Interface_GetParentSystem (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_SYSTEM_HANDLE *systemHandle)
	Asks the given interface for its parent system.
PEAK_C_API	PEAK_Interface_UpdateDevices (PEAK_INTERFACE_HANDLE interfaceHandle, uint64_t timeout_ms)
	Tells the given interface to update its devices with the given timeout.
PEAK_C_API	PEAK_Interface_GetNumDevices (PEAK_INTERFACE_HANDLE interfaceHandle, size_t *numDevices)
	Asks the given interface for its number of devices.
PEAK_C_API	PEAK_Interface_GetDevice (PEAK_INTERFACE_HANDLE interfaceHandle, size_t index, PEAK_DEVICE_DESCRIPTOR_HANDLE *deviceDescriptorHandle)
	Asks the given interface for the device descriptor with the given index.
PEAK_C_API	PEAK_Interface_RegisterDeviceFoundCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_FOUND_CALLBACK callback, void *callbackContext, PEAK_DEVICE_FOUND_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a found device at the given interface.
PEAK_C_API	PEAK_Interface_UnregisterDeviceFoundCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_FOUND_CALLBACK_HANDLE callbackHandle)
	Unregisters the device-found callback with the given handle from the given interface.
PEAK_C_API	PEAK_Interface_RegisterDeviceReconnectedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_RECONNECTED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a reconnected device at the given interface.
PEAK_C_API	PEAK_Interface_UnregisterDeviceReconnectedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE callbackHandle)
	Unregisters the device-reconnected callback with the given handle from the given interface.
PEAK_C_API	PEAK_Interface_RegisterDeviceDisconnectedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_DISCONNETED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a disconnected device that is now waiting to be reconnected at the given interface.
PEAK_C_API	PEAK_Interface_UnregisterDeviceDisconnectedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE callbackHandle)
	Unregisters the device disconnected callback with the given handle from the given interface.
PEAK_C_API	PEAK_Interface_RegisterDeviceLostCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LOST_CALLBACK callback, void *callbackContext, PEAK_DEVICE_LOST_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a lost device at the given interface.
PEAK_C_API	PEAK_Interface_UnregisterDeviceLostCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LOST_CALLBACK_HANDLE callbackHandle)
	Unregisters the device-lost callback with the given handle from the given interface.
PEAK_C_API	PEAK_Interface_RegisterDeviceListChangedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LIST_CHANGED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a change in the device list at the given interface.
PEAK_C_API	PEAK_Interface_UnregisterDeviceListChangedCallback (PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE callbackHandle)
	Unregisters the device-list-changed callback with the given handle from the given interface.
PEAK_C_API	PEAK_Interface_Destruct (PEAK_INTERFACE_HANDLE interfaceHandle)
	Destroys the given interface.
PEAK_C_API	PEAK_DeviceDescriptor_ToModuleDescriptor (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
	Casts the given device descriptor to a module descriptor.
PEAK_C_API	PEAK_DeviceDescriptor_GetKey (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *key, size_t *keySize)
	Asks the given device descriptor for its key.
PEAK_C_API	PEAK_DeviceDescriptor_GetInfo (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given device descriptor for an information based on a specific command.
PEAK_C_API	PEAK_DeviceDescriptor_GetDisplayName (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *displayName, size_t *displayNameSize)
	Asks the given device descriptor for its display name.
PEAK_C_API	PEAK_DeviceDescriptor_GetVendorName (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *vendorName, size_t *vendorNameSize)
	Asks the given device descriptor for its vendor name.
PEAK_C_API	PEAK_DeviceDescriptor_GetModelName (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *modelName, size_t *modelNameSize)
	Asks the given device descriptor for its model name.
PEAK_C_API	PEAK_DeviceDescriptor_GetVersion (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *version, size_t *versionSize)
	Asks the given device descriptor for its version.
PEAK_C_API	PEAK_DeviceDescriptor_GetTLType (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *tlType, size_t *tlTypeSize)
	Asks the given device descriptor for its TL type.
PEAK_C_API	PEAK_DeviceDescriptor_GetUserDefinedName (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *userDefinedName, size_t *userDefinedNameSize)
	Asks the given device descriptor for its user-defined name.
PEAK_C_API	PEAK_DeviceDescriptor_GetSerialNumber (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *serialNumber, size_t *serialNumberSize)
	Asks the given device descriptor for its serial number.
PEAK_C_API	PEAK_DeviceDescriptor_GetAccessStatus (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_STATUS *accessStatus)
	Asks the given device descriptor for its access status.
PEAK_C_API	PEAK_DeviceDescriptor_GetTimestampTickFrequency (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t *timestampTickFrequency)
	Asks the given device descriptor for its timestamp tick frequency.
PEAK_C_API	PEAK_DeviceDescriptor_GetIsOpenableExclusive (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_BOOL8 *isOpenable)
	Asks the given device descriptor whether the device can be opened with exclusive access.
PEAK_C_API	PEAK_DeviceDescriptor_GetIsOpenable (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_BOOL8 *isOpenable)
	Asks the given device descriptor whether the device can be opened with this specific access type.
PEAK_C_API	PEAK_DeviceDescriptor_OpenDevice (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_DEVICE_HANDLE *deviceHandle)
	Opens the device being associated with the given interface descriptor for the given access type.
PEAK_C_API	PEAK_DeviceDescriptor_GetParentInterface (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
	Asks the given device descriptor for its parent interface.
PEAK_C_API	PEAK_DeviceDescriptor_GetMonitoringUpdateInterval (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t *monitoringUpdateInterval_ms)
	Asks the given device descriptor for its monitoring update interval.
PEAK_C_API	PEAK_DeviceDescriptor_SetMonitoringUpdateInterval (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t monitoringUpdateInterval_ms)
	Tells the given device descriptor to set the given monitoring update interval.
PEAK_C_API	PEAK_DeviceDescriptor_IsInformationRoleMonitored (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole, PEAK_BOOL8 *isInformationRoleMonitored)
	Asks the given device descriptor whether the given information role is monitored.
PEAK_C_API	PEAK_DeviceDescriptor_AddInformationRoleToMonitoring (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole)
	Tells the given device descriptor to add the given information role to the monitoring.
PEAK_C_API	PEAK_DeviceDescriptor_RemoveInformationRoleFromMonitoring (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole)
	Tells the given device descriptor to remove the given information role from the monitoring.
PEAK_C_API	PEAK_DeviceDescriptor_RegisterInformationChangedCallback (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling changed information at the given device descriptor.
PEAK_C_API	PEAK_DeviceDescriptor_UnregisterInformationChangedCallback (PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE callbackHandle)
	Unregisters the information changed callback with the given handle from the given device descriptor.
PEAK_C_API	PEAK_Device_ToModule (PEAK_DEVICE_HANDLE deviceHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given device to a module.
PEAK_C_API	PEAK_Device_ToEventSupportingModule (PEAK_DEVICE_HANDLE deviceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
	Casts the given device to an event-supporting module.
PEAK_C_API	PEAK_Device_GetKey (PEAK_DEVICE_HANDLE deviceHandle, char *key, size_t *keySize)
	Asks the given device for its key.
PEAK_C_API	PEAK_Device_GetInfo (PEAK_DEVICE_HANDLE deviceHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given device for an information based on a specific command.
PEAK_C_API	PEAK_Device_GetID (PEAK_DEVICE_HANDLE deviceHandle, char *id, size_t *idSize)
	Asks the given device for its ID.
PEAK_C_API	PEAK_Device_GetDisplayName (PEAK_DEVICE_HANDLE deviceHandle, char *displayName, size_t *displayNameSize)
	Asks the given device for its display name.
PEAK_C_API	PEAK_Device_GetVendorName (PEAK_DEVICE_HANDLE deviceHandle, char *vendorName, size_t *vendorNameSize)
	Asks the given device for its vendor name.
PEAK_C_API	PEAK_Device_GetModelName (PEAK_DEVICE_HANDLE deviceHandle, char *modelName, size_t *modelNameSize)
	Asks the given device for its model name.
PEAK_C_API	PEAK_Device_GetVersion (PEAK_DEVICE_HANDLE deviceHandle, char *version, size_t *versionSize)
	Asks the given device for its version.
PEAK_C_API	PEAK_Device_GetTLType (PEAK_DEVICE_HANDLE deviceHandle, char *tlType, size_t *tlTypeSize)
	Asks the given device for its TL type.
PEAK_C_API	PEAK_Device_GetUserDefinedName (PEAK_DEVICE_HANDLE deviceHandle, char *userDefinedName, size_t *userDefinedNameSize)
	Asks the given device for its user-defined name.
PEAK_C_API	PEAK_Device_GetSerialNumber (PEAK_DEVICE_HANDLE deviceHandle, char *serialNumber, size_t *serialNumberSize)
	Asks the given device for its serial number.
PEAK_C_API	PEAK_Device_GetAccessStatus (PEAK_DEVICE_HANDLE deviceHandle, PEAK_DEVICE_ACCESS_STATUS *accessStatus)
	Asks the given device for its access status.
PEAK_C_API	PEAK_Device_GetTimestampTickFrequency (PEAK_DEVICE_HANDLE deviceHandle, uint64_t *timestampTickFrequency)
	Asks the given device for its timestamp tick frequency.
PEAK_C_API	PEAK_Device_GetParentInterface (PEAK_DEVICE_HANDLE deviceHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
	Asks the given device for its parent interface.
PEAK_C_API	PEAK_Device_GetRemoteDevice (PEAK_DEVICE_HANDLE deviceHandle, PEAK_REMOTE_DEVICE_HANDLE *remoteDeviceHandle)
	Asks the given device for its remote device.
PEAK_C_API	PEAK_Device_GetNumDataStreams (PEAK_DEVICE_HANDLE deviceHandle, size_t *numDataStreams)
	Asks the given device for its number of data streams.
PEAK_C_API	PEAK_Device_GetDataStream (PEAK_DEVICE_HANDLE deviceHandle, size_t index, PEAK_DATA_STREAM_DESCRIPTOR_HANDLE *dataStreamDescriptorHandle)
	Asks the given device for the data stream descriptor with the given index.
PEAK_C_API	PEAK_Device_Destruct (PEAK_DEVICE_HANDLE deviceHandle)
	Delete the given device.
PEAK_C_API	PEAK_RemoteDevice_ToModule (PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given remote device to a module.
PEAK_C_API	PEAK_RemoteDevice_GetLocalDevice (PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_DEVICE_HANDLE *deviceHandle)
	Asks the given remote device for its local device.
PEAK_C_API	PEAK_DataStreamDescriptor_ToModuleDescriptor (PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
	Casts the given data stream descriptor to a module descriptor.
PEAK_C_API	PEAK_DataStreamDescriptor_GetKey (PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, char *key, size_t *keySize)
	Asks the given data stream descriptor for its key.
PEAK_C_API	PEAK_DataStreamDescriptor_GetParentDevice (PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DEVICE_HANDLE *deviceHandle)
	Asks the given data stream descriptor for its parent device.
PEAK_C_API	PEAK_DataStreamDescriptor_OpenDataStream (PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DATA_STREAM_HANDLE *dataStreamHandle)
	Opens the data stream being associated with the given data stream descriptor.
PEAK_C_API	PEAK_DataStream_ToModule (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given data stream to a module.
PEAK_C_API	PEAK_DataStream_ToEventSupportingModule (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
	Casts the given data stream to an event-supporting module.
PEAK_C_API	PEAK_DataStream_GetKey (PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *key, size_t *keySize)
	Asks the given data stream for its key.
PEAK_C_API	PEAK_DataStream_GetInfo (PEAK_DATA_STREAM_HANDLE dataStreamHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given data stream for an information based on a specific command.
PEAK_C_API	PEAK_DataStream_GetID (PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *id, size_t *idSize)
	Asks the given data stream for its ID.
PEAK_C_API	PEAK_DataStream_GetTLType (PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *tlType, size_t *tlTypeSize)
	Asks the given data stream for its TL type.
PEAK_C_API	PEAK_DataStream_GetNumBuffersAnnouncedMinRequired (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAnnouncedMinRequired)
	Asks the given data stream for its minimum required number of announced buffers.
PEAK_C_API	PEAK_DataStream_GetNumBuffersAnnounced (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAnnounced)
	Asks the given data stream for its number of announced buffers.
PEAK_C_API	PEAK_DataStream_GetNumBuffersQueued (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersQueued)
	Asks the given data stream for its number of queued buffers.
PEAK_C_API	PEAK_DataStream_GetNumBuffersAwaitDelivery (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAwaitDelivery)
	Asks the given data stream for its number of buffers awaiting delivery.
PEAK_C_API	PEAK_DataStream_GetNumBuffersDelivered (PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numBuffersDelivered)
	Asks the given data stream for its number of delivered buffers.
PEAK_C_API	PEAK_DataStream_GetNumBuffersStarted (PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numBuffersStarted)
	Asks the given data stream for its number of started buffers.
PEAK_C_API	PEAK_DataStream_GetNumUnderruns (PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numUnderruns)
	Asks the given data stream for its number of underruns.
PEAK_C_API	PEAK_DataStream_GetNumChunksPerBufferMax (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numChunksPerBufferMax)
	Asks the given data stream for its maximum number of chunks per buffer.
PEAK_C_API	PEAK_DataStream_GetBufferAlignment (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *bufferAlignment)
	Asks the given data stream for its buffer alignment.
PEAK_C_API	PEAK_DataStream_GetPayloadSize (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *payloadSize)
	Asks the given data stream for its payload size.
PEAK_C_API	PEAK_DataStream_GetDefinesPayloadSize (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BOOL8 *definesPayloadSize)
	Asks the given data stream whether it defines the payload size.
PEAK_C_API	PEAK_DataStream_GetIsGrabbing (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BOOL8 *isGrabbing)
	Asks the given data stream whether it is grabbing.
PEAK_C_API	PEAK_DataStream_GetParentDevice (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DEVICE_HANDLE *deviceHandle)
	Asks the given data stream for its parent device.
PEAK_C_API	PEAK_DataStream_AnnounceBuffer (PEAK_DATA_STREAM_HANDLE dataStreamHandle, void *buffer, size_t bufferSize, void *userPtr, PEAK_BUFFER_REVOCATION_CALLBACK revocationCallback, void *callbackContext, PEAK_BUFFER_HANDLE *bufferHandle)
	Announces the given buffer at the given data stream.
PEAK_C_API	PEAK_DataStream_AllocAndAnnounceBuffer (PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t bufferSize, void *userPtr, PEAK_BUFFER_HANDLE *bufferHandle)
	Tells the given data stream to allocate and announce a buffer with the given size.
PEAK_C_API	PEAK_DataStream_QueueBuffer (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle)
	Tells the given data stream to queue the given buffer.
PEAK_C_API	PEAK_DataStream_RevokeBuffer (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle)
	Tells the given data stream to revoke the given buffer.
PEAK_C_API	PEAK_DataStream_WaitForFinishedBuffer (PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t timeout_ms, PEAK_BUFFER_HANDLE *bufferHandle)
	Blocking wait for a finished Buffer.
PEAK_C_API	PEAK_DataStream_KillWait (PEAK_DATA_STREAM_HANDLE dataStreamHandle)
	Tells the data stream to kill one call to PEAK_DataStream_WaitForFinishedBuffer.
PEAK_C_API	PEAK_DataStream_FlushPendingKillWaits (PEAK_DATA_STREAM_HANDLE dataStreamHandle)
	Flushes the KillWait queue.
PEAK_C_API	PEAK_DataStream_Flush (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DATA_STREAM_FLUSH_MODE flushMode)
	Tells the given data stream to flush its queues using the given mode.
PEAK_C_API	PEAK_DataStream_StartAcquisitionInfinite (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode)
	Tells the given data stream to start the acquisition using the given mode.
PEAK_C_API	PEAK_DataStream_StartAcquisition (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode, uint64_t numToAcquire)
	Tells the given data stream to start the acquisition using the given mode and to acquire the given number of buffers.
PEAK_C_API	PEAK_DataStream_StopAcquisition (PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_STOP_MODE stopMode)
	Tells the given data stream to stop the acquisition using the given mode.
PEAK_C_API	PEAK_DataStream_Destruct (PEAK_DATA_STREAM_HANDLE dataStreamHandle)
	Destroys the given data stream.
PEAK_C_API	PEAK_Buffer_ToModule (PEAK_BUFFER_HANDLE bufferHandle, PEAK_MODULE_HANDLE *moduleHandle)
	Casts the given buffer to a module.
PEAK_C_API	PEAK_Buffer_ToEventSupportingModule (PEAK_BUFFER_HANDLE bufferHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
	Casts the given buffer to an event-supporting module.
PEAK_C_API	PEAK_Buffer_GetInfo (PEAK_BUFFER_HANDLE bufferHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given buffer for an information based on a specific command.
PEAK_C_API	PEAK_Buffer_GetTLType (PEAK_BUFFER_HANDLE bufferHandle, char *tlType, size_t *tlTypeSize)
	Asks the given buffer for its TL type.
PEAK_C_API	PEAK_Buffer_GetBasePtr (PEAK_BUFFER_HANDLE bufferHandle, void **basePtr)
	Asks the given buffer for its base pointer.
PEAK_C_API	PEAK_Buffer_GetSize (PEAK_BUFFER_HANDLE bufferHandle, size_t *size)
	Asks the given buffer for its size.
PEAK_C_API	PEAK_Buffer_GetUserPtr (PEAK_BUFFER_HANDLE bufferHandle, void **userPtr)
	Asks the given buffer for its user pointer.
PEAK_C_API	PEAK_Buffer_GetPayloadType (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BUFFER_PAYLOAD_TYPE *payloadType)
	Asks the given buffer for its payload type.
PEAK_C_API	PEAK_Buffer_GetPixelFormat (PEAK_BUFFER_HANDLE bufferHandle, uint64_t *pixelFormat)
	Asks the given buffer for its pixel format.
PEAK_C_API	PEAK_Buffer_GetPixelFormatNamespace (PEAK_BUFFER_HANDLE bufferHandle, PEAK_PIXEL_FORMAT_NAMESPACE *pixelFormatNamespace)
	Asks the given buffer for its pixel format namespace.
PEAK_C_API	PEAK_Buffer_GetPixelEndianness (PEAK_BUFFER_HANDLE bufferHandle, PEAK_ENDIANNESS *pixelEndianness)
	Asks the given buffer for its pixel endianness.
PEAK_C_API	PEAK_Buffer_GetExpectedDataSize (PEAK_BUFFER_HANDLE bufferHandle, size_t *expectedDataSize)
	Asks the given buffer for its expected data size.
PEAK_C_API	PEAK_Buffer_GetDeliveredDataSize (PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredDataSize)
	Asks the given buffer for its delivered data size.
PEAK_C_API	PEAK_Buffer_GetFrameID (PEAK_BUFFER_HANDLE bufferHandle, uint64_t *frameId)
	Asks the given buffer for its frame ID.
PEAK_C_API	PEAK_Buffer_GetImageOffset (PEAK_BUFFER_HANDLE bufferHandle, size_t *imageOffset)
	Asks the given buffer for its image offset.
PEAK_C_API	PEAK_Buffer_GetDeliveredImageHeight (PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredImageHeight)
	Asks the given buffer for its delivered image height.
PEAK_C_API	PEAK_Buffer_GetDeliveredChunkPayloadSize (PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredChunkPayloadSize)
	Asks the given buffer for its delivered chunk payload size.
PEAK_C_API	PEAK_Buffer_GetChunkLayoutID (PEAK_BUFFER_HANDLE bufferHandle, uint64_t *chunkLayoutId)
	Asks the given buffer for its chunk layout ID.
PEAK_C_API	PEAK_Buffer_GetFileName (PEAK_BUFFER_HANDLE bufferHandle, char *fileName, size_t *fileNameSize)
	Asks the given buffer for its file name.
PEAK_C_API	PEAK_Buffer_GetWidth (PEAK_BUFFER_HANDLE bufferHandle, size_t *width)
	Asks the given buffer for its width.
PEAK_C_API	PEAK_Buffer_GetHeight (PEAK_BUFFER_HANDLE bufferHandle, size_t *height)
	Asks the given buffer for its height.
PEAK_C_API	PEAK_Buffer_GetXOffset (PEAK_BUFFER_HANDLE bufferHandle, size_t *xOffset)
	Asks the given buffer for its X offset.
PEAK_C_API	PEAK_Buffer_GetYOffset (PEAK_BUFFER_HANDLE bufferHandle, size_t *yOffset)
	Asks the given buffer for its Y offset.
PEAK_C_API	PEAK_Buffer_GetXPadding (PEAK_BUFFER_HANDLE bufferHandle, size_t *xPadding)
	Asks the given buffer for its X padding.
PEAK_C_API	PEAK_Buffer_GetYPadding (PEAK_BUFFER_HANDLE bufferHandle, size_t *yPadding)
	Asks the given buffer for its Y padding.
PEAK_C_API	PEAK_Buffer_GetTimestamp_ticks (PEAK_BUFFER_HANDLE bufferHandle, uint64_t *timestamp_ticks)
	Asks the given buffer for its timestamp in ticks.
PEAK_C_API	PEAK_Buffer_GetTimestamp_ns (PEAK_BUFFER_HANDLE bufferHandle, uint64_t *timestamp_ns)
	Asks the given buffer for its timestamp in nanoseconds.
PEAK_C_API	PEAK_Buffer_GetIsQueued (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isQueued)
	Asks the given buffer whether it is queued.
PEAK_C_API	PEAK_Buffer_GetIsAcquiring (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isAcquiring)
	Asks the given buffer whether it is acquiring.
PEAK_C_API	PEAK_Buffer_GetIsIncomplete (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isIncomplete)
	Asks the given buffer whether it is incomplete.
PEAK_C_API	PEAK_Buffer_GetHasNewData (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasNewData)
	Asks the given buffer whether it has new data since the last delivery.
PEAK_C_API	PEAK_Buffer_GetHasImage (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasImage)
	Asks the given buffer whether it is has an image.
PEAK_C_API	PEAK_Buffer_GetHasChunks (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasChunks)
	Asks the given buffer whether it has chunks.
PEAK_C_API	PEAK_Buffer_GetHasParts (PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasParts)
	Asks the given buffer whether it has parts.
PEAK_C_API	PEAK_Buffer_UpdateChunks (PEAK_BUFFER_HANDLE bufferHandle)
	Tells the given buffer to update its chunks.
PEAK_C_API	PEAK_Buffer_GetNumChunks (PEAK_BUFFER_HANDLE bufferHandle, size_t *numChunks)
	Asks the given buffer for its number of chunks.
PEAK_C_API	PEAK_Buffer_GetChunk (PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_CHUNK_HANDLE *bufferChunkHandle)
	Asks the given buffer for the chunk with the given index.
PEAK_C_API	PEAK_Buffer_UpdateParts (PEAK_BUFFER_HANDLE bufferHandle)
	Tells the given buffer to update its parts.
PEAK_C_API	PEAK_Buffer_GetNumParts (PEAK_BUFFER_HANDLE bufferHandle, size_t *numParts)
	Asks the given buffer for its number of parts.
PEAK_C_API	PEAK_Buffer_GetPart (PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_PART_HANDLE *bufferPartHandle)
	Asks the given buffer for the part with the given index.
PEAK_C_API	PEAK_BufferChunk_GetID (PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, uint64_t *id)
	Asks the given buffer chunk for its ID.
PEAK_C_API	PEAK_BufferChunk_GetBasePtr (PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, void **basePtr)
	Asks the given buffer chunk for its base pointer.
PEAK_C_API	PEAK_BufferChunk_GetSize (PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, size_t *size)
	Asks the given buffer chunk for its size.
PEAK_C_API	PEAK_BufferChunk_GetParentBuffer (PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, PEAK_BUFFER_HANDLE *bufferHandle)
	Asks the given buffer chunk for its parent buffer.
PEAK_C_API	PEAK_BufferChunk_Destruct (PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle)
	Destroys the given buffer chunk.
PEAK_C_API	PEAK_BufferPart_GetInfo (PEAK_BUFFER_PART_HANDLE bufferPartHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given buffer part for an information based on a specific command.
PEAK_C_API	PEAK_BufferPart_GetSourceID (PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *sourceId)
	Asks the given buffer part for its source ID.
PEAK_C_API	PEAK_BufferPart_GetBasePtr (PEAK_BUFFER_PART_HANDLE bufferPartHandle, void **basePtr)
	Asks the given buffer part for its base pointer.
PEAK_C_API	PEAK_BufferPart_GetSize (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *size)
	Asks the given buffer part for its size.
PEAK_C_API	PEAK_BufferPart_GetType (PEAK_BUFFER_PART_HANDLE bufferPartHandle, PEAK_BUFFER_PART_TYPE *type)
	Asks the given buffer part for its type.
PEAK_C_API	PEAK_BufferPart_GetFormat (PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *format)
	Asks the given buffer part for its format.
PEAK_C_API	PEAK_BufferPart_GetFormatNamespace (PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *formatNamespace)
	Asks the given buffer part for its format namespace.
PEAK_C_API	PEAK_BufferPart_GetWidth (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *width)
	Asks the given buffer part for its width.
PEAK_C_API	PEAK_BufferPart_GetHeight (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *height)
	Asks the given buffer part for its height.
PEAK_C_API	PEAK_BufferPart_GetXOffset (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *xOffset)
	Asks the given buffer part for its X offset.
PEAK_C_API	PEAK_BufferPart_GetYOffset (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *yOffset)
	Asks the given buffer part for its Y offset.
PEAK_C_API	PEAK_BufferPart_GetXPadding (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *xPadding)
	Asks the given buffer part for its X padding.
PEAK_C_API	PEAK_BufferPart_GetDeliveredImageHeight (PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *deliveredImageHeight)
	Asks the given buffer part for its delivered image height.
PEAK_C_API	PEAK_BufferPart_GetParentBuffer (PEAK_BUFFER_PART_HANDLE bufferPartHandle, PEAK_BUFFER_HANDLE *bufferHandle)
	Asks the given buffer part for its parent buffer.
PEAK_C_API	PEAK_BufferPart_Destruct (PEAK_BUFFER_PART_HANDLE bufferPartHandle)
	Destroys the given buffer part.
PEAK_C_API	PEAK_ModuleDescriptor_GetID (PEAK_MODULE_DESCRIPTOR_HANDLE moduleDescriptorHandle, char *id, size_t *idSize)
	Asks the given module descriptor for its ID.
PEAK_C_API	PEAK_Module_GetNumNodeMaps (PEAK_MODULE_HANDLE moduleHandle, size_t *numNodeMaps)
	Asks the given module for its number of node maps.
PEAK_C_API	PEAK_Module_GetNodeMap (PEAK_MODULE_HANDLE moduleHandle, size_t index, PEAK_NODE_MAP_HANDLE *nodeMapHandle)
	Asks the given module for the node map with the given index.
PEAK_C_API	PEAK_Module_GetPort (PEAK_MODULE_HANDLE moduleHandle, PEAK_PORT_HANDLE *portHandle)
	Asks the given module for its port.
PEAK_C_API	PEAK_NodeMap_GetHasNode (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_BOOL8 *hasNode)
	Checks whether the given node map contains a node with the given name.
PEAK_C_API	PEAK_NodeMap_FindNode (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE *nodeHandle)
	Tells the given node map to find a node with the given name.
PEAK_C_API	PEAK_NodeMap_TryFindNode (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE *nodeHandle)
	Tells the given node map to try to find a node with the given name.
PEAK_C_API	PEAK_NodeMap_InvalidateNodes (PEAK_NODE_MAP_HANDLE nodeMapHandle)
	Tells the given node map to invalidate its nodes.
PEAK_C_API	PEAK_NodeMap_PollNodes (PEAK_NODE_MAP_HANDLE nodeMapHandle, int64_t elapsedTime_ms)
	Tells the given node map to poll its nodes.
PEAK_C_API	PEAK_NodeMap_GetNumNodes (PEAK_NODE_MAP_HANDLE nodeMapHandle, size_t *numNodes)
	Asks the given node map for its number of nodes.
PEAK_C_API	PEAK_NodeMap_GetNode (PEAK_NODE_MAP_HANDLE nodeMapHandle, size_t index, PEAK_NODE_HANDLE *nodeHandle)
	Asks the given node map for the node with the given index.
PEAK_C_API	PEAK_NodeMap_GetHasBufferSupportedChunks (PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasSupportedChunks)
	Checks if the buffer contains chunks corresponding to the node map.
PEAK_C_API	PEAK_NodeMap_UpdateChunkNodes (PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle)
	Updates chunk information in the node map.
PEAK_C_API	PEAK_NodeMap_GetHasEventSupportedData (PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_EVENT_HANDLE eventHandle, PEAK_BOOL8 *hasSupportedData)
	Checks if the event contains data corresponding to the node map.
PEAK_C_API	PEAK_NodeMap_UpdateEventNodes (PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_EVENT_HANDLE eventHandle)
	Updates event information in the node map.
PEAK_C_API	PEAK_NodeMap_StoreToFile (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *filePath, size_t filePathSize)
	Tells the given node map to store the values of its streamable nodes to a file at the given file path.
PEAK_C_API	PEAK_NodeMap_LoadFromFile (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *filePath, size_t filePathSize)
	Tells the given node map to load the values of its streamable nodes from a file at the given file path.
PEAK_C_API	PEAK_NodeMap_Lock (PEAK_NODE_MAP_HANDLE nodeMapHandle)
	Locks a recursive mutex on the NodeMap.
PEAK_C_API	PEAK_NodeMap_TryLock (PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BOOL8 *locked)
	Tries to Lock a recursive mutex on the NodeMap. Use this to synchronize NodeMap access from multiple threads. The call is non-blocking and the state is returned in locked. In case the lock was acquired, it must be released by a call to PEAK_NodeMap_Unlock when done.
PEAK_C_API	PEAK_NodeMap_Unlock (PEAK_NODE_MAP_HANDLE nodeMapHandle)
	Unlocks the recursive mutex on the NodeMap.
PEAK_C_API	PEAK_Node_ToIntegerNode (PEAK_NODE_HANDLE nodeHandle, PEAK_INTEGER_NODE_HANDLE *integerNodeHandle)
	Casts the given node to an integer node.
PEAK_C_API	PEAK_Node_ToBooleanNode (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOLEAN_NODE_HANDLE *booleanNodeHandle)
	Casts the given node to a boolean node.
PEAK_C_API	PEAK_Node_ToCommandNode (PEAK_NODE_HANDLE nodeHandle, PEAK_COMMAND_NODE_HANDLE *commandNodeHandle)
	Casts the given node to a command node.
PEAK_C_API	PEAK_Node_ToFloatNode (PEAK_NODE_HANDLE nodeHandle, PEAK_FLOAT_NODE_HANDLE *floatNodeHandle)
	Casts the given node to a float node.
PEAK_C_API	PEAK_Node_ToStringNode (PEAK_NODE_HANDLE nodeHandle, PEAK_STRING_NODE_HANDLE *stringNodeHandle)
	Casts the given node to a string node.
PEAK_C_API	PEAK_Node_ToRegisterNode (PEAK_NODE_HANDLE nodeHandle, PEAK_REGISTER_NODE_HANDLE *registerNodeHandle)
	Casts the given node to a register node.
PEAK_C_API	PEAK_Node_ToCategoryNode (PEAK_NODE_HANDLE nodeHandle, PEAK_CATEGORY_NODE_HANDLE *categoryNodeHandle)
	Casts the given node to a category node.
PEAK_C_API	PEAK_Node_ToEnumerationNode (PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_NODE_HANDLE *enumerationNodeHandle)
	Casts the given node to an enumeration node.
PEAK_C_API	PEAK_Node_ToEnumerationEntryNode (PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Casts the given node to an enumeration entry node.
PEAK_C_API	PEAK_Node_GetName (PEAK_NODE_HANDLE nodeHandle, char *name, size_t *nameSize)
	Asks the given node for its name.
PEAK_C_API	PEAK_Node_GetDisplayName (PEAK_NODE_HANDLE nodeHandle, char *displayName, size_t *displayNameSize)
	Asks the given node for its display name.
PEAK_C_API	PEAK_Node_GetNamespace (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_NAMESPACE *_namespace)
	Asks the given node for its namespace.
PEAK_C_API	PEAK_Node_GetVisibility (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_VISIBILITY *visibility)
	Asks the given node for its visibility.
PEAK_C_API	PEAK_Node_GetAccessStatus (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_ACCESS_STATUS *accessStatus)
	Asks the given node for its access status.
PEAK_C_API	PEAK_Node_GetIsCacheable (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isCacheable)
	Asks the given node whether it is cacheable.
PEAK_C_API	PEAK_Node_GetIsAccessStatusCacheable (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isAccessStatusCacheable)
	Asks the given node whether its access status is cacheable.
PEAK_C_API	PEAK_Node_GetIsStreamable (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isStreamable)
	Asks the given node whether it is streamable.
PEAK_C_API	PEAK_Node_GetIsDeprecated (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isDeprecated)
	Asks the given node whether it is deprecated.
PEAK_C_API	PEAK_Node_GetIsFeature (PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isFeature)
	Asks the given node whether it is a feature, i.e. it can be reached via category nodes from a category node named "Root".
PEAK_C_API	PEAK_Node_GetCachingMode (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CACHING_MODE *cachingMode)
	Asks the given node for its caching mode.
PEAK_C_API	PEAK_Node_GetPollingTime (PEAK_NODE_HANDLE nodeHandle, int64_t *pollingTime_ms)
	Asks the given node for its polling time.
PEAK_C_API	PEAK_Node_GetToolTip (PEAK_NODE_HANDLE nodeHandle, char *toolTip, size_t *toolTipSize)
	Asks the given node for its tooltip.
PEAK_C_API	PEAK_Node_GetDescription (PEAK_NODE_HANDLE nodeHandle, char *description, size_t *descriptionSize)
	Asks the given node for its description.
PEAK_C_API	PEAK_Node_GetType (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_TYPE *type)
	Asks the given node for its type.
PEAK_C_API	PEAK_Node_GetParentNodeMap (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_MAP_HANDLE *nodeMapHandle)
	Asks the given node for its parent node map.
PEAK_C_API	PEAK_Node_FindInvalidatedNode (PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *invalidatedNodeHandle)
	Tells the given node to find an invalidated node with the given name.
PEAK_C_API	PEAK_Node_GetNumInvalidatedNodes (PEAK_NODE_HANDLE nodeHandle, size_t *numInvalidatedNodes)
	Asks the given node for its number of invalidated nodes.
PEAK_C_API	PEAK_Node_GetInvalidatedNode (PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *invalidatedNodeHandle)
	Asks the given node for the invalidated node with the given index.
PEAK_C_API	PEAK_Node_FindInvalidatingNode (PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *invalidatingNodeHandle)
	Tells the given node to find an invalidating node with the given name.
PEAK_C_API	PEAK_Node_GetNumInvalidatingNodes (PEAK_NODE_HANDLE nodeHandle, size_t *numInvalidatingNodes)
	Asks the given node for its number of invalidating nodes.
PEAK_C_API	PEAK_Node_GetInvalidatingNode (PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *invalidatingNodeHandle)
	Asks the given node for the invalidating node with the given index.
PEAK_C_API	PEAK_Node_FindSelectedNode (PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *selectedNodeHandle)
	Tells the given node to find a selected node with the given name.
PEAK_C_API	PEAK_Node_GetNumSelectedNodes (PEAK_NODE_HANDLE nodeHandle, size_t *numSelectedNodes)
	Asks the given node for its number of selected nodes.
PEAK_C_API	PEAK_Node_GetSelectedNode (PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *selectedNodeHandle)
	Asks the given node for the selected node with the given index.
PEAK_C_API	PEAK_Node_FindSelectingNode (PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *selectingNodeHandle)
	Tells the given node to find a selecting node with the given name.
PEAK_C_API	PEAK_Node_GetNumSelectingNodes (PEAK_NODE_HANDLE nodeHandle, size_t *numSelectingNodes)
	Asks the given node for its number of selecting nodes.
PEAK_C_API	PEAK_Node_GetSelectingNode (PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *selectingNodeHandle)
	Asks the given node for the selecting node with the given index.
PEAK_C_API	PEAK_Node_RegisterChangedCallback (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CHANGED_CALLBACK callback, void *callbackContext, PEAK_NODE_CHANGED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a change at the given node.
PEAK_C_API	PEAK_Node_UnregisterChangedCallback (PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CHANGED_CALLBACK_HANDLE callbackHandle)
	Unregisters the changed callback with the given handle from the given node.
PEAK_C_API	PEAK_IntegerNode_ToNode (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given integer node to a node.
PEAK_C_API	PEAK_IntegerNode_GetMinimum (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *minimum)
	Asks the given integer node for its minimum.
PEAK_C_API	PEAK_IntegerNode_GetMaximum (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *maximum)
	Asks the given integer node for its maximum.
PEAK_C_API	PEAK_IntegerNode_GetIncrement (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *increment)
	Asks the given integer node for its increment.
PEAK_C_API	PEAK_IntegerNode_GetIncrementType (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_INCREMENT_TYPE *incrementType)
	Asks the given integer node for its increment type.
PEAK_C_API	PEAK_IntegerNode_GetValidValues (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *validValues, size_t *validValuesSize)
	Asks the given integer node for its valid values.
PEAK_C_API	PEAK_IntegerNode_GetRepresentation (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_REPRESENTATION *representation)
	Asks the given integer node for its representation.
PEAK_C_API	PEAK_IntegerNode_GetUnit (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, char *unit, size_t *unitSize)
	Asks the given integer node for its unit.
PEAK_C_API	PEAK_IntegerNode_GetValue (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, int64_t *value)
	Asks the given integer node for its value.
PEAK_C_API	PEAK_IntegerNode_SetValue (PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t value)
	Tells the given integer node to set the given value.
PEAK_C_API	PEAK_BooleanNode_ToNode (PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given boolean node to a node.
PEAK_C_API	PEAK_BooleanNode_GetValue (PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_BOOL8 *value)
	Asks the given boolean node for its value.
PEAK_C_API	PEAK_BooleanNode_SetValue (PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_BOOL8 value)
	Tells the given boolean node to set the given value.
PEAK_C_API	PEAK_CommandNode_ToNode (PEAK_COMMAND_NODE_HANDLE commandNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given command node to a node.
PEAK_C_API	PEAK_CommandNode_GetIsDone (PEAK_COMMAND_NODE_HANDLE commandNodeHandle, PEAK_BOOL8 *isDone)
	Asks the given command node whether its associated command is done.
PEAK_C_API	PEAK_CommandNode_Execute (PEAK_COMMAND_NODE_HANDLE commandNodeHandle)
	Tells the given command node to execute its associated command.
PEAK_C_API	PEAK_CommandNode_WaitUntilDoneInfinite (PEAK_COMMAND_NODE_HANDLE commandNodeHandle)
	Waits (blocking) without timeout until the previously executed command is finished, i.e. PEAK_CommandNode_GetIsDone() returns true.
PEAK_C_API	PEAK_CommandNode_WaitUntilDone (PEAK_COMMAND_NODE_HANDLE commandNodeHandle, uint64_t waitTimeout_ms)
	Waits (blocking) until the previously executed command is finished, i.e. PEAK_CommandNode_GetIsDone() returns true.
PEAK_C_API	PEAK_FloatNode_ToNode (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given float node to a node.
PEAK_C_API	PEAK_FloatNode_GetMinimum (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *minimum)
	Asks the given float node for its minimum.
PEAK_C_API	PEAK_FloatNode_GetMaximum (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *maximum)
	Asks the given float node for its maximum.
PEAK_C_API	PEAK_FloatNode_GetIncrement (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *increment)
	Asks the given float node for its increment.
PEAK_C_API	PEAK_FloatNode_GetIncrementType (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_INCREMENT_TYPE *incrementType)
	Asks the given float node for its increment type.
PEAK_C_API	PEAK_FloatNode_GetValidValues (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *validValues, size_t *validValuesSize)
	Asks the given float node for its valid values.
PEAK_C_API	PEAK_FloatNode_GetRepresentation (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_REPRESENTATION *representation)
	Asks the given float node for its representation.
PEAK_C_API	PEAK_FloatNode_GetUnit (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, char *unit, size_t *unitSize)
	Asks the given float node for its unit.
PEAK_C_API	PEAK_FloatNode_GetDisplayNotation (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_DISPLAY_NOTATION *displayNotation)
	Asks the given float node for its display notation.
PEAK_C_API	PEAK_FloatNode_GetDisplayPrecision (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, int64_t *displayPrecision)
	Asks the given float node for its display precision.
PEAK_C_API	PEAK_FloatNode_GetHasConstantIncrement (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_BOOL8 *hasConstantIncrement)
	Asks the given float node whether it has a constant increment.
PEAK_C_API	PEAK_FloatNode_GetValue (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, double *value)
	Asks the given float node for its value.
PEAK_C_API	PEAK_FloatNode_SetValue (PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double value)
	Tells the given float node to set the given value.
PEAK_C_API	PEAK_StringNode_ToNode (PEAK_STRING_NODE_HANDLE stringNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given string node to a node.
PEAK_C_API	PEAK_StringNode_GetMaximumLength (PEAK_STRING_NODE_HANDLE stringNodeHandle, int64_t *maximumLength)
	Asks the given string node for its maximum length.
PEAK_C_API	PEAK_StringNode_GetValue (PEAK_STRING_NODE_HANDLE stringNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, char *value, size_t *valueSize)
	Asks the given string node for its value.
PEAK_C_API	PEAK_StringNode_SetValue (PEAK_STRING_NODE_HANDLE stringNodeHandle, const char *value, size_t valueSize)
	Tells the given string node to set the given value.
PEAK_C_API	PEAK_RegisterNode_ToNode (PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given register node to a node.
PEAK_C_API	PEAK_RegisterNode_GetAddress (PEAK_REGISTER_NODE_HANDLE registerNodeHandle, uint64_t *address)
	Asks the given register node for its address.
PEAK_C_API	PEAK_RegisterNode_GetLength (PEAK_REGISTER_NODE_HANDLE registerNodeHandle, size_t *length)
	Asks the given register node for its length.
PEAK_C_API	PEAK_RegisterNode_Read (PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, uint8_t *bytesToRead, size_t bytesToReadSize)
	Tells the given register node to read the given amount of bytes.
PEAK_C_API	PEAK_RegisterNode_Write (PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const uint8_t *bytesToWrite, size_t bytesToWriteSize)
	Tells the given register node to write the given bytes.
PEAK_C_API	PEAK_CategoryNode_ToNode (PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given category node to a node.
PEAK_C_API	PEAK_CategoryNode_GetNumSubNodes (PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, size_t *numSubNodes)
	Asks the given category node for its number of sub nodes.
PEAK_C_API	PEAK_CategoryNode_GetSubNode (PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, size_t index, PEAK_NODE_HANDLE *nodeHandle)
	Asks the given category node for the sub node with the given index.
PEAK_C_API	PEAK_EnumerationNode_ToNode (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given enumeration node to a node.
PEAK_C_API	PEAK_EnumerationNode_GetCurrentEntry (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Asks the given enumeration node for its current entry.
PEAK_C_API	PEAK_EnumerationNode_SetCurrentEntry (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle)
	Tells the given enumeration node to set its current entry to the given entry.
PEAK_C_API	PEAK_EnumerationNode_SetCurrentEntryBySymbolicValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize)
	Tells the given enumeration node to set its current entry by the given symbolic value.
PEAK_C_API	PEAK_EnumerationNode_SetCurrentEntryByValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value)
	Tells the given enumeration node to set its current entry by the given value.
PEAK_C_API	PEAK_EnumerationNode_GetHasEntryBySymbolicValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_BOOL8 *hasEntry)
	Asks the given enumeration node whether it has an entry with the given symbolic value.
PEAK_C_API	PEAK_EnumerationNode_GetHasEntryByValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_BOOL8 *hasEntry)
	Asks the given enumeration node whether it has an entry with the given value.
PEAK_C_API	PEAK_EnumerationNode_FindEntryBySymbolicValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Tells the given enumeration node to find an entry with the given symbolic value.
PEAK_C_API	PEAK_EnumerationNode_FindEntryByValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Tells the given enumeration node to find an entry with the given value.
PEAK_C_API	PEAK_EnumerationNode_TryFindEntryBySymbolicValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Tells the given enumeration node to try to find an entry with the given symbolic value.
PEAK_C_API	PEAK_EnumerationNode_TryFindEntryByValue (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Tells the given enumeration node to try to find an entry with the given value.
PEAK_C_API	PEAK_EnumerationNode_GetNumEntries (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, size_t *numEntries)
	Asks the given enumeration node for its number of entries.
PEAK_C_API	PEAK_EnumerationNode_GetEntry (PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, size_t index, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
	Asks the given enumeration node for the entry with the given index.
PEAK_C_API	PEAK_EnumerationEntryNode_ToNode (PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
	Casts the given enumeration entry node to a node.
PEAK_C_API	PEAK_EnumerationEntryNode_GetIsSelfClearing (PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_BOOL8 *isSelfClearing)
	Asks the given enumeration entry node whether it is self clearing.
PEAK_C_API	PEAK_EnumerationEntryNode_GetSymbolicValue (PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, char *symbolicValue, size_t *symbolicValueSize)
	Asks the given enumeration entry node for its symbolic value.
PEAK_C_API	PEAK_EnumerationEntryNode_GetValue (PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, int64_t *value)
	Asks the given enumeration entry node for its value.
PEAK_C_API	PEAK_Port_GetInfo (PEAK_PORT_HANDLE portHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given port for an information based on a specific command.
PEAK_C_API	PEAK_Port_GetID (PEAK_PORT_HANDLE portHandle, char *id, size_t *idSize)
	Asks the given port for its ID.
PEAK_C_API	PEAK_Port_GetName (PEAK_PORT_HANDLE portHandle, char *name, size_t *nameSize)
	Asks the given port for its name.
PEAK_C_API	PEAK_Port_GetVendorName (PEAK_PORT_HANDLE portHandle, char *vendorName, size_t *vendorNameSize)
	Asks the given port for its vendor name.
PEAK_C_API	PEAK_Port_GetModelName (PEAK_PORT_HANDLE portHandle, char *modelName, size_t *modelNameSize)
	Asks the given port for its model name.
PEAK_C_API	PEAK_Port_GetVersion (PEAK_PORT_HANDLE portHandle, char *version, size_t *versionSize)
	Asks the given port for its version.
PEAK_C_API	PEAK_Port_GetTLType (PEAK_PORT_HANDLE portHandle, char *tlType, size_t *tlTypeSize)
	Asks the given port for its TL type.
PEAK_C_API	PEAK_Port_GetModuleName (PEAK_PORT_HANDLE portHandle, char *moduleName, size_t *moduleNameSize)
	Asks the given port for its module name.
PEAK_C_API	PEAK_Port_GetDataEndianness (PEAK_PORT_HANDLE portHandle, PEAK_ENDIANNESS *dataEndianness)
	Asks the given port for its data endianness.
PEAK_C_API	PEAK_Port_GetIsReadable (PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isReadable)
	Asks the given port whether it is readable.
PEAK_C_API	PEAK_Port_GetIsWritable (PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isWritable)
	Asks the given port whether it is writable.
PEAK_C_API	PEAK_Port_GetIsAvailable (PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isAvailable)
	Asks the given port whether it is available.
PEAK_C_API	PEAK_Port_GetIsImplemented (PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isImplemented)
	Asks the given port whether it is implemented.
PEAK_C_API	PEAK_Port_Read (PEAK_PORT_HANDLE portHandle, uint64_t address, uint8_t *bytesToRead, size_t bytesToReadSize)
	Tells the given port to read the given amount of bytes at the given address.
PEAK_C_API	PEAK_Port_Write (PEAK_PORT_HANDLE portHandle, uint64_t address, const uint8_t *bytesToWrite, size_t bytesToWriteSize)
	Tells the given port to write the given amount of bytes at the given address.
PEAK_C_API	PEAK_Port_GetNumURLs (PEAK_PORT_HANDLE portHandle, size_t *numUrls)
	Asks the given port for its number of URLs.
PEAK_C_API	PEAK_Port_GetURL (PEAK_PORT_HANDLE portHandle, size_t index, PEAK_PORT_URL_HANDLE *portUrlHandle)
	Asks the given port for the URL with the given index.
PEAK_C_API	PEAK_PortURL_GetInfo (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given port URL for an information based on a specific command.
PEAK_C_API	PEAK_PortURL_GetURL (PEAK_PORT_URL_HANDLE portUrlHandle, char *url, size_t *urlSize)
	Asks the given port URL for its URL string.
PEAK_C_API	PEAK_PortURL_GetScheme (PEAK_PORT_URL_HANDLE portUrlHandle, PEAK_PORT_URL_SCHEME *scheme)
	Asks the given port URL for its scheme.
PEAK_C_API	PEAK_PortURL_GetFileName (PEAK_PORT_URL_HANDLE portUrlHandle, char *fileName, size_t *fileNameSize)
	Asks the given port URL for its file name.
PEAK_C_API	PEAK_PortURL_GetFileRegisterAddress (PEAK_PORT_URL_HANDLE portUrlHandle, uint64_t *fileRegisterAddress)
	Asks the given port URL for its file register address.
PEAK_C_API	PEAK_PortURL_GetFileSize (PEAK_PORT_URL_HANDLE portUrlHandle, uint64_t *fileSize)
	Asks the given port URL for its file size.
PEAK_C_API	PEAK_PortURL_GetFileSHA1Hash (PEAK_PORT_URL_HANDLE portUrlHandle, uint8_t *fileSha1Hash, size_t *fileSha1HashSize)
	Asks the given port URL for its file SHA1 hash.
PEAK_C_API	PEAK_PortURL_GetFileVersionMajor (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionMajor)
	Asks the given port URL for the major component of its file version.
PEAK_C_API	PEAK_PortURL_GetFileVersionMinor (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionMinor)
	Asks the given port URL for the minor component of its file version.
PEAK_C_API	PEAK_PortURL_GetFileVersionSubminor (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionSubminor)
	Asks the given port URL for the subminor component of its file version.
PEAK_C_API	PEAK_PortURL_GetFileSchemaVersionMajor (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileSchemaVersionMajor)
	Asks the given port URL for the major component of its file schema version.
PEAK_C_API	PEAK_PortURL_GetFileSchemaVersionMinor (PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileSchemaVersionMinor)
	Asks the given port URL for the minor component of its file schema version.
PEAK_C_API	PEAK_PortURL_GetParentPort (PEAK_PORT_URL_HANDLE portUrlHandle, PEAK_PORT_HANDLE *portHandle)
	Asks the given port URL for its parent port.
PEAK_C_API	PEAK_EventSupportingModule_EnableEvents (PEAK_EVENT_SUPPORTING_MODULE_HANDLE eventSupportingModuleHandle, PEAK_EVENT_TYPE eventType, PEAK_EVENT_CONTROLLER_HANDLE *eventControllerHandle)
	Tells the given event-supporting module to enable events of the given type.
PEAK_C_API	PEAK_EventController_GetInfo (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given event controller for an information based on a specific command.
PEAK_C_API	PEAK_EventController_GetNumEventsInQueue (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *numEventsInQueue)
	Asks the event controller for its number of events in queue.
PEAK_C_API	PEAK_EventController_GetNumEventsFired (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t *numEventsFired)
	Asks the event controller for its number of fired events.
PEAK_C_API	PEAK_EventController_GetEventMaxSize (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventMaxSize)
	Asks the event controller for the maximum size of an event.
PEAK_C_API	PEAK_EventController_GetEventDataMaxSize (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventDataMaxSize)
	Asks the event controller for the maximum size of an event's data.
PEAK_C_API	PEAK_EventController_GetControlledEventType (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, PEAK_EVENT_TYPE *controlledEventType)
	Asks the event controller for its controlled event type.
PEAK_C_API	PEAK_EventController_WaitForEvent (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t timeout_ms, PEAK_EVENT_HANDLE *eventHandle)
	Tells the given event controller to wait for an event with the given timeout.
PEAK_C_API	PEAK_EventController_KillWait (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
	Cancels a pending PEAK_EventController_WaitForEvent call.
PEAK_C_API	PEAK_EventController_FlushPendingKillWaits (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
	Flushes the KillWait queue.
PEAK_C_API	PEAK_EventController_FlushEvents (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
	Tells the given event controller to flush all events in queue.
PEAK_C_API	PEAK_EventController_Destruct (PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
	Destroys the given event controller.
PEAK_C_API	PEAK_Event_GetInfo (PEAK_EVENT_HANDLE eventHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
	Asks the given event for an information based on a specific command.
PEAK_C_API	PEAK_Event_GetID (PEAK_EVENT_HANDLE eventHandle, uint64_t *id)
	Asks the given event for its ID.
PEAK_C_API	PEAK_Event_GetData (PEAK_EVENT_HANDLE eventHandle, uint8_t *data, size_t *dataSize)
	Asks the given event for its data.
PEAK_C_API	PEAK_Event_GetType (PEAK_EVENT_HANDLE eventHandle, PEAK_EVENT_TYPE *type)
	Asks the given event for its type.
PEAK_C_API	PEAK_Event_GetRawData (PEAK_EVENT_HANDLE eventHandle, uint8_t *rawData, size_t *rawDataSize)
	Asks the given event for its raw data.
PEAK_C_API	PEAK_Event_Destruct (PEAK_EVENT_HANDLE eventHandle)
	Destroys the given event.
PEAK_C_API	PEAK_FirmwareUpdater_Construct (PEAK_FIRMWARE_UPDATER_HANDLE *firmwareUpdaterHandle)
	Creates a firmware updater.
PEAK_C_API	PEAK_FirmwareUpdater_CollectAllFirmwareUpdateInformation (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char *gufPath, size_t gufPathSize)
	Tells the given firmware updater to collect all update information from the .guf file.
PEAK_C_API	PEAK_FirmwareUpdater_CollectFirmwareUpdateInformation (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char *gufPath, size_t gufPathSize, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle)
	Tells the given firmware updater to collect all update information fitting to the given device.
PEAK_C_API	PEAK_FirmwareUpdater_GetNumFirmwareUpdateInformation (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t *numFirmwareUpdateInformation)
	Asks the given firmware updater for its number of update information.
PEAK_C_API	PEAK_FirmwareUpdater_GetFirmwareUpdateInformation (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t index, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE *firmwareUpdateInformationHandle)
	Asks the given firmware updater for the update information with the given index.
PEAK_C_API	PEAK_FirmwareUpdater_UpdateDevice (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle)
	Tells the given firmware updater to update the given device with the given update information.
PEAK_C_API	PEAK_FirmwareUpdater_UpdateDeviceWithResetTimeout (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, uint64_t deviceResetDiscoveryTimeout_ms)
	Tells the given firmware updater to update the given device with the given update information.
PEAK_C_API	PEAK_FirmwareUpdater_Destruct (PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle)
	Destroys the given firmware updater.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetIsValid (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_BOOL8 *isValid)
	Asks the given firmware update information whether it is valid.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetFileName (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *fileName, size_t *fileNameSize)
	Asks the given firmware update information for its file name.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetDescription (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *description, size_t *descriptionSize)
	Asks the given firmware update information for its description.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetVersion (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *version, size_t *versionSize)
	Asks the given firmware update information for its version.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetVersionExtractionPattern (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *versionExtractionPattern, size_t *versionExtractionPatternSize)
	Asks the given firmware update information for its version extraction pattern.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetVersionStyle (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_VERSION_STYLE *versionStyle)
	Asks the given firmware update information for its version style.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetReleaseNotes (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *releaseNotes, size_t *releaseNotesSize)
	Asks the given firmware update information for its release notes.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetReleaseNotesURL (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *releaseNotesUrl, size_t *releaseNotesUrlSize)
	Asks the given firmware update information for its release notes URL.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetUserSetPersistence (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PERSISTENCE *userSetPersistence)
	Asks the given firmware update information for its user set persistence.
PEAK_C_API	PEAK_FirmwareUpdateInformation_GetSequencerSetPersistence (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PERSISTENCE *sequencerSetPersistence)
	Asks the given firmware update information for its sequencer set persistence.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_Construct (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE *firmwareUpdateProgressObserverHandle)
	Creates a firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStartedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a started update at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStartedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update started callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepStartedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a started update step at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepStartedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update step started callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepProgressChangedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a progress change within an update step at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepProgressChangedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update step progress changed callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepFinishedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a finished update step at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepFinishedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update step finished callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFinishedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a finished update at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFinishedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update finished callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFailedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE *callbackHandle)
	Registers a callback signaling a failed update at the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFailedCallback (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE callbackHandle)
	Unregisters the update failed callback with the given handle from the given firmware update progress observer.
PEAK_C_API	PEAK_FirmwareUpdateProgressObserver_Destruct (PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle)
	Destroys the given firmware update progress observer.
PEAK_C_API	PEAK_FileAdapter_Construct (PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *fileName, PEAK_FILE_ADAPTER_HANDLE *fileAdapterHandle)
	Creates a file adapter.
PEAK_C_API	PEAK_FileAdapter_Destruct (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle)
	Destroys the given file adapter.
PEAK_C_API	PEAK_FileAdapter_Read (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t size, uint64_t offset, uint8_t *data, uint64_t *dataSize)
	Reads from the given file.
PEAK_C_API	PEAK_FileAdapter_Write (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, const uint8_t *data, uint64_t size, uint64_t offset)
	Writes to the given file.
PEAK_C_API	PEAK_FileAdapter_Delete (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle)
	Deletes the given file.
PEAK_C_API	PEAK_FileAdapter_GetSize (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t *size)
	Queries the size of the given file.
PEAK_C_API	PEAK_FileAdapter_GetMaxSize (PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t *maxSize)
	Queries the maximum size of the given file.

Detailed Description

Author

IDS Imaging Development Systems GmbH

Date

2019-05-01

Since

1.0

Copyright (c) 2019 - 2025, IDS Imaging Development Systems GmbH. All rights reserved.

Macro Definition Documentation

PEAK_C_API

#define PEAK_C_API   PEAK_PUBLIC PEAK_RETURN_CODE PEAK_CALL_CONV

PEAK_MAYBE_UNUSED

#define PEAK_MAYBE_UNUSED

PEAK_NO_DISCARD

#define PEAK_NO_DISCARD

Typedef Documentation

PEAK_ACQUISITION_START_MODE

typedef int32_t PEAK_ACQUISITION_START_MODE

PEAK_ACQUISITION_STOP_MODE

typedef int32_t PEAK_ACQUISITION_STOP_MODE

PEAK_BOOL8

typedef int8_t PEAK_BOOL8

PEAK_BOOLEAN_NODE_HANDLE

typedef struct PEAK_BOOLEAN_NODE* PEAK_BOOLEAN_NODE_HANDLE

The type of boolean node handles.

PEAK_BUFFER_CHUNK_HANDLE

typedef struct PEAK_BUFFER_CHUNK* PEAK_BUFFER_CHUNK_HANDLE

The type of buffer chunk handles.

PEAK_BUFFER_HANDLE

typedef struct PEAK_BUFFER* PEAK_BUFFER_HANDLE

The type of buffer handles.

PEAK_BUFFER_PART_HANDLE

typedef struct PEAK_BUFFER_PART* PEAK_BUFFER_PART_HANDLE

The type of buffer part handles.

PEAK_BUFFER_PART_TYPE

typedef int32_t PEAK_BUFFER_PART_TYPE

PEAK_BUFFER_PAYLOAD_TYPE

typedef int32_t PEAK_BUFFER_PAYLOAD_TYPE

PEAK_BUFFER_REVOCATION_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_BUFFER_REVOCATION_CALLBACK) (void *buffer, void *userPtr, void *context)

The type of buffer revocation callbacks

PEAK_CATEGORY_NODE_HANDLE

typedef struct PEAK_CATEGORY_NODE* PEAK_CATEGORY_NODE_HANDLE

The type of category node handles.

PEAK_CHARACTER_ENCODING

typedef int32_t PEAK_CHARACTER_ENCODING

PEAK_COMMAND_NODE_HANDLE

typedef struct PEAK_COMMAND_NODE* PEAK_COMMAND_NODE_HANDLE

The type of command node handles.

PEAK_DATA_STREAM_DESCRIPTOR_HANDLE

typedef struct PEAK_DATA_STREAM_DESCRIPTOR* PEAK_DATA_STREAM_DESCRIPTOR_HANDLE

The type of data stream descriptor handles.

PEAK_DATA_STREAM_FLUSH_MODE

typedef int32_t PEAK_DATA_STREAM_FLUSH_MODE

PEAK_DATA_STREAM_HANDLE

typedef struct PEAK_DATA_STREAM* PEAK_DATA_STREAM_HANDLE

The type of data stream handles.

PEAK_DEVICE_ACCESS_STATUS

typedef int32_t PEAK_DEVICE_ACCESS_STATUS

PEAK_DEVICE_ACCESS_TYPE

typedef int32_t PEAK_DEVICE_ACCESS_TYPE

PEAK_DEVICE_DESCRIPTOR_HANDLE

typedef struct PEAK_DEVICE_DESCRIPTOR* PEAK_DEVICE_DESCRIPTOR_HANDLE

The type of device descriptor handles.

PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK) (const PEAK_DEVICE_INFORMATION_ROLE *changedRoles, size_t changedRolesSize, void *context)

The type of device descriptor information changed callbacks

PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE

typedef PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK* PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE

The type of device descriptor information changed callback handles

PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE

typedef PEAK_DEVICE_DISCONNETED_CALLBACK* PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE

The type of device disconnected callback handles

PEAK_DEVICE_DISCONNETED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_DISCONNETED_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE disconnectedDevice, void *context)

The type of device disconnected callbacks

PEAK_DEVICE_FOUND_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_FOUND_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE foundDevice, void *context)

The type of device found callbacks

PEAK_DEVICE_FOUND_CALLBACK_HANDLE

typedef PEAK_DEVICE_FOUND_CALLBACK* PEAK_DEVICE_FOUND_CALLBACK_HANDLE

The type of device found callback handles

PEAK_DEVICE_HANDLE

typedef struct PEAK_DEVICE* PEAK_DEVICE_HANDLE

The type of device handles.

PEAK_DEVICE_INFORMATION_ROLE

typedef int32_t PEAK_DEVICE_INFORMATION_ROLE

PEAK_DEVICE_LIST_CHANGED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_LIST_CHANGED_CALLBACK) (void *context)

The type of device list changed callbacks

PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE

typedef PEAK_DEVICE_LIST_CHANGED_CALLBACK* PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE

The type of device list changed callback handles

PEAK_DEVICE_LOST_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_LOST_CALLBACK) (const char *lostDeviceId, size_t lostDeviceIdSize, void *context)

The type of device lost callbacks

PEAK_DEVICE_LOST_CALLBACK_HANDLE

typedef PEAK_DEVICE_LOST_CALLBACK* PEAK_DEVICE_LOST_CALLBACK_HANDLE

The type of device lost callback handles

PEAK_DEVICE_RECONNECT_ERROR_FLAGS

typedef uint32_t PEAK_DEVICE_RECONNECT_ERROR_FLAGS

PEAK_DEVICE_RECONNECTED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_DEVICE_RECONNECTED_CALLBACK) (PEAK_DEVICE_DESCRIPTOR_HANDLE reconnectedDevice, PEAK_DEVICE_RECONNECT_INFORMATION reconnectInformation, void *context)

The type of device reconnected callbacks

PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE

typedef PEAK_DEVICE_RECONNECTED_CALLBACK* PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE

The type of device reconnected callback handles

PEAK_ENDIANNESS

typedef int32_t PEAK_ENDIANNESS

PEAK_ENUMERATION_ENTRY_NODE_HANDLE

typedef struct PEAK_ENUMERATION_ENTRY_NODE* PEAK_ENUMERATION_ENTRY_NODE_HANDLE

The type of enumeration entry node handles.

PEAK_ENUMERATION_NODE_HANDLE

typedef struct PEAK_ENUMERATION_NODE* PEAK_ENUMERATION_NODE_HANDLE

The type of enumeration node handles.

PEAK_EVENT_CONTROLLER_HANDLE

typedef struct PEAK_EVENT_CONTROLLER* PEAK_EVENT_CONTROLLER_HANDLE

The type of event controller handles.

PEAK_EVENT_HANDLE

typedef struct PEAK_EVENT* PEAK_EVENT_HANDLE

The type of event handles.

PEAK_EVENT_SUPPORTING_MODULE_HANDLE

typedef struct PEAK_EVENT_SUPPORTING_MODULE* PEAK_EVENT_SUPPORTING_MODULE_HANDLE

The type of event supporting module handles.

PEAK_EVENT_TYPE

typedef int32_t PEAK_EVENT_TYPE

PEAK_FILE_ADAPTER_HANDLE

typedef struct PEAK_FILE_ADAPTER* PEAK_FILE_ADAPTER_HANDLE

The type of file adapter handles.

PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK) (const char *errorDescription, size_t errorDescriptionSize, void *context)

The type of firmware update failed callbacks

PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK* PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE

The type of firmware update failed callback handles

PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK) (void *context)

The type of firmware update finished callbacks

PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK* PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE

The type of firmware update finished callback handles

PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE

typedef struct PEAK_FIRMWARE_UPDATE_INFORMATION* PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE

The type of firmware update information handles.

PEAK_FIRMWARE_UPDATE_PERSISTENCE

typedef int32_t PEAK_FIRMWARE_UPDATE_PERSISTENCE

PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE

typedef struct PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER* PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE

The type of firmware update progress observer handles.

PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK) (PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, uint32_t estimatedDuration_ms, void *context)

The type of firmware update started callbacks

PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK* PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE

The type of firmware update started callback handles

PEAK_FIRMWARE_UPDATE_STEP

typedef int32_t PEAK_FIRMWARE_UPDATE_STEP

PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, void *context)

The type of firmware update step finished callbacks

PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK* PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE

The type of firmware update step finished callback handles

PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, double progressPercentage, void *context)

The type of firmware update step progress changed callbacks

PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK* PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE

The type of firmware update step progress changed callback handles

PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK) (PEAK_FIRMWARE_UPDATE_STEP updateStep, uint32_t estimatedDuration_ms, const char *description, size_t descriptionSize, void *context)

The type of firmware update step started callbacks

PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE

typedef PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK* PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE

The type of firmware update step started callback handles

PEAK_FIRMWARE_UPDATE_VERSION_STYLE

typedef int32_t PEAK_FIRMWARE_UPDATE_VERSION_STYLE

PEAK_FIRMWARE_UPDATER_HANDLE

typedef struct PEAK_FIRMWARE_UPDATER* PEAK_FIRMWARE_UPDATER_HANDLE

The type of firmware updater handles.

PEAK_FLOAT_NODE_HANDLE

typedef struct PEAK_FLOAT_NODE* PEAK_FLOAT_NODE_HANDLE

The type of float node handles.

PEAK_INTEGER_NODE_HANDLE

typedef struct PEAK_INTEGER_NODE* PEAK_INTEGER_NODE_HANDLE

The type of integer node handles.

PEAK_INTERFACE_DESCRIPTOR_HANDLE

typedef struct PEAK_INTERFACE_DESCRIPTOR* PEAK_INTERFACE_DESCRIPTOR_HANDLE

The type of interface descriptor handles.

PEAK_INTERFACE_FOUND_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_INTERFACE_FOUND_CALLBACK) (PEAK_INTERFACE_DESCRIPTOR_HANDLE foundInterface, void *context)

The type of interface found callbacks

PEAK_INTERFACE_FOUND_CALLBACK_HANDLE

typedef PEAK_INTERFACE_FOUND_CALLBACK* PEAK_INTERFACE_FOUND_CALLBACK_HANDLE

The type of interface found callback handles

PEAK_INTERFACE_HANDLE

typedef struct PEAK_INTERFACE* PEAK_INTERFACE_HANDLE

The type of interface handles.

PEAK_INTERFACE_LIST_CHANGED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_INTERFACE_LIST_CHANGED_CALLBACK) (void *context)

The type of interface list changedcallbacks

PEAK_INTERFACE_LIST_CHANGED_CALLBACK_HANDLE

typedef PEAK_INTERFACE_LIST_CHANGED_CALLBACK* PEAK_INTERFACE_LIST_CHANGED_CALLBACK_HANDLE

The type of interface list changed callback handles

PEAK_INTERFACE_LOST_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_INTERFACE_LOST_CALLBACK) (const char *lostInterfaceId, size_t lostInterfaceIdSize, void *context)

The type of interface lost callbacks

PEAK_INTERFACE_LOST_CALLBACK_HANDLE

typedef PEAK_INTERFACE_LOST_CALLBACK* PEAK_INTERFACE_LOST_CALLBACK_HANDLE

The type of interface lost callback handles

PEAK_MODULE_DESCRIPTOR_HANDLE

typedef struct PEAK_MODULE_DESCRIPTOR* PEAK_MODULE_DESCRIPTOR_HANDLE

The type of module descriptor handles.

PEAK_MODULE_HANDLE

typedef struct PEAK_MODULE* PEAK_MODULE_HANDLE

The type of module handles.

PEAK_NODE_ACCESS_STATUS

typedef int32_t PEAK_NODE_ACCESS_STATUS

PEAK_NODE_CACHE_USE_POLICY

typedef int32_t PEAK_NODE_CACHE_USE_POLICY

PEAK_NODE_CACHING_MODE

typedef int32_t PEAK_NODE_CACHING_MODE

PEAK_NODE_CHANGED_CALLBACK

typedef void(PEAK_CALL_CONV * PEAK_NODE_CHANGED_CALLBACK) (PEAK_NODE_HANDLE changedNode, void *context)

The type of node changed callbacks

PEAK_NODE_CHANGED_CALLBACK_HANDLE

typedef PEAK_NODE_CHANGED_CALLBACK* PEAK_NODE_CHANGED_CALLBACK_HANDLE

The type of node changed callback handles

PEAK_NODE_DISPLAY_NOTATION

typedef int32_t PEAK_NODE_DISPLAY_NOTATION

PEAK_NODE_HANDLE

typedef struct PEAK_NODE* PEAK_NODE_HANDLE

The type of node handles.

PEAK_NODE_INCREMENT_TYPE

typedef int32_t PEAK_NODE_INCREMENT_TYPE

PEAK_NODE_MAP_HANDLE

typedef struct PEAK_NODE_MAP* PEAK_NODE_MAP_HANDLE

The type of node map handles.

PEAK_NODE_NAMESPACE

typedef int32_t PEAK_NODE_NAMESPACE

PEAK_NODE_REPRESENTATION

typedef int32_t PEAK_NODE_REPRESENTATION

PEAK_NODE_TYPE

typedef int32_t PEAK_NODE_TYPE

PEAK_NODE_VISIBILITY

typedef int32_t PEAK_NODE_VISIBILITY

PEAK_PIXEL_FORMAT_NAMESPACE

typedef int32_t PEAK_PIXEL_FORMAT_NAMESPACE

PEAK_PORT_HANDLE

typedef struct PEAK_PORT* PEAK_PORT_HANDLE

The type of port handles.

PEAK_PORT_URL_HANDLE

typedef struct PEAK_PORT_URL* PEAK_PORT_URL_HANDLE

The type of port URL handles.

PEAK_PORT_URL_SCHEME

typedef int32_t PEAK_PORT_URL_SCHEME

PEAK_PRODUCER_LIBRARY_HANDLE

typedef struct PEAK_PRODUCER_LIBRARY* PEAK_PRODUCER_LIBRARY_HANDLE

The type of producer library handles.

PEAK_REGISTER_NODE_HANDLE

typedef struct PEAK_REGISTER_NODE* PEAK_REGISTER_NODE_HANDLE

The type of register node handles.

PEAK_REMOTE_DEVICE_HANDLE

typedef struct PEAK_REMOTE_DEVICE* PEAK_REMOTE_DEVICE_HANDLE

The type of remote device handles.

PEAK_RETURN_CODE

typedef int32_t PEAK_RETURN_CODE

PEAK_STRING_NODE_HANDLE

typedef struct PEAK_STRING_NODE* PEAK_STRING_NODE_HANDLE

The type of string node handles.

PEAK_SYSTEM_DESCRIPTOR_HANDLE

typedef struct PEAK_SYSTEM_DESCRIPTOR* PEAK_SYSTEM_DESCRIPTOR_HANDLE

The type of system descriptor handles.

PEAK_SYSTEM_HANDLE

typedef struct PEAK_SYSTEM* PEAK_SYSTEM_HANDLE

The type of system handles.

Enumeration Type Documentation

PEAK_ACQUISITION_START_MODE_t

enum PEAK_ACQUISITION_START_MODE_t

The enum holding the possible acquisition start modes.

Enumerator
PEAK_ACQUISITION_START_MODE_DEFAULT
PEAK_ACQUISITION_START_MODE_CUSTOM

PEAK_ACQUISITION_STOP_MODE_t

enum PEAK_ACQUISITION_STOP_MODE_t

The enum holding the possible acquisition stop modes.

Enumerator
PEAK_ACQUISITION_STOP_MODE_DEFAULT
PEAK_ACQUISITION_STOP_MODE_KILL
PEAK_ACQUISITION_STOP_MODE_CUSTOM

PEAK_BUFFER_PART_TYPE_t

enum PEAK_BUFFER_PART_TYPE_t

The enum holding the possible buffer part types.

Enumerator
PEAK_BUFFER_PART_TYPE_UNKNOWN
PEAK_BUFFER_PART_TYPE_IMAGE_2D
PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_2D
PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_2D
PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_2D
PEAK_BUFFER_PART_TYPE_IMAGE_3D
PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_3D
PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_3D
PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_3D
PEAK_BUFFER_PART_TYPE_CONFIDENCE_MAP
PEAK_BUFFER_PART_TYPE_CUSTOM

PEAK_BUFFER_PAYLOAD_TYPE_t

enum PEAK_BUFFER_PAYLOAD_TYPE_t

The enum holding the possible buffer payload types.

Enumerator
PEAK_BUFFER_PAYLOAD_TYPE_UNKNOWN
PEAK_BUFFER_PAYLOAD_TYPE_IMAGE
PEAK_BUFFER_PAYLOAD_TYPE_RAW_DATA
PEAK_BUFFER_PAYLOAD_TYPE_FILE
PEAK_BUFFER_PAYLOAD_TYPE_CHUNK
PEAK_BUFFER_PAYLOAD_TYPE_JPEG
PEAK_BUFFER_PAYLOAD_TYPE_JPEG_2000
PEAK_BUFFER_PAYLOAD_TYPE_H264
PEAK_BUFFER_PAYLOAD_TYPE_CHUNK_ONLY
PEAK_BUFFER_PAYLOAD_TYPE_DEVICE_SPECIFIC
PEAK_BUFFER_PAYLOAD_TYPE_MULTI_PART
PEAK_BUFFER_PAYLOAD_TYPE_CUSTOM

PEAK_CHARACTER_ENCODING_t

enum PEAK_CHARACTER_ENCODING_t

The enum holding the possible character encodings.

Enumerator
PEAK_CHARACTER_ENCODING_ASCII
PEAK_CHARACTER_ENCODING_UTF8

PEAK_DATA_STREAM_FLUSH_MODE_t

enum PEAK_DATA_STREAM_FLUSH_MODE_t

The enum holding the possible data stream flush modes.

Enumerator
PEAK_DATA_STREAM_FLUSH_MODE_INPUT_POOL_TO_OUTPUT_QUEUE
PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_OUTPUT_QUEUE
PEAK_DATA_STREAM_FLUSH_MODE_ALL_TO_INPUT_POOL
PEAK_DATA_STREAM_FLUSH_MODE_UNQUEUED_TO_INPUT_POOL
PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_ALL
PEAK_DATA_STREAM_FLUSH_MODE_CUSTOM

PEAK_DEVICE_ACCESS_STATUS_t

enum PEAK_DEVICE_ACCESS_STATUS_t

The enum holding the possible device access status.

Enumerator
PEAK_DEVICE_ACCESS_STATUS_READ_WRITE
PEAK_DEVICE_ACCESS_STATUS_READ_ONLY
PEAK_DEVICE_ACCESS_STATUS_NO_ACCESS
PEAK_DEVICE_ACCESS_STATUS_BUSY
PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_WRITE
PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_ONLY
PEAK_DEVICE_ACCESS_STATUS_CUSTOM

PEAK_DEVICE_ACCESS_TYPE_t

enum PEAK_DEVICE_ACCESS_TYPE_t

The enum holding the possible device access types.

Enumerator
PEAK_DEVICE_ACCESS_TYPE_READ_ONLY
PEAK_DEVICE_ACCESS_TYPE_CONTROL
PEAK_DEVICE_ACCESS_TYPE_EXCLUSIVE
PEAK_DEVICE_ACCESS_TYPE_CUSTOM

PEAK_DEVICE_INFORMATION_ROLE_t

enum PEAK_DEVICE_INFORMATION_ROLE_t

The enum holding the possible device information roles.

Enumerator
PEAK_DEVICE_INFORMATION_ROLE_ID
PEAK_DEVICE_INFORMATION_ROLE_VENDOR_NAME
PEAK_DEVICE_INFORMATION_ROLE_MODEL_NAME
PEAK_DEVICE_INFORMATION_ROLE_TL_TYPE
PEAK_DEVICE_INFORMATION_ROLE_DISPLAY_NAME
PEAK_DEVICE_INFORMATION_ROLE_ACCESS_STATUS
PEAK_DEVICE_INFORMATION_ROLE_USER_DEFINED_NAME
PEAK_DEVICE_INFORMATION_ROLE_SERIAL_NUMBER
PEAK_DEVICE_INFORMATION_ROLE_VERSION
PEAK_DEVICE_INFORMATION_ROLE_TIMESTAMP_TICK_FREQUENCY
PEAK_DEVICE_INFORMATION_ROLE_CUSTOM

PEAK_DEVICE_RECONNECT_ERROR_t

enum PEAK_DEVICE_RECONNECT_ERROR_t

Enumerator
PEAK_DEVICE_RECONNECT_OPERATION_NO_ERROR	No error occurred
PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_ERROR	Indicates that the TL could not restart the remote device acquisition.
PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_PAYLOAD_SIZE_LARGER_THAN_BUFFERS	The configured payload size is larger than the buffers announced in the data stream. Either the buffers must be reallocated to a larger size or the remote device configuration must be adjusted so the reported payload size is smaller or equal to the allocated buffers
PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_CONFIGURATION_RESTORE_ERROR	Indicates that the TL could not restore the remote devices configuration.

PEAK_ENDIANNESS_t

enum PEAK_ENDIANNESS_t

The enum holding the possible endianness types.

Enumerator
PEAK_ENDIANNESS_UNKNOWN
PEAK_ENDIANNESS_LITTLE
PEAK_ENDIANNESS_BIG

PEAK_EVENT_TYPE_t

enum PEAK_EVENT_TYPE_t

The enum holding the possible event types.

Enumerator
PEAK_EVENT_TYPE_ERROR
PEAK_EVENT_TYPE_FEATURE_INVALIDATE
PEAK_EVENT_TYPE_FEATURE_CHANGE
PEAK_EVENT_TYPE_REMOTE_DEVICE
PEAK_EVENT_TYPE_MODULE
PEAK_EVENT_TYPE_FEATURE_CUSTOM

PEAK_FIRMWARE_UPDATE_PERSISTENCE_t

enum PEAK_FIRMWARE_UPDATE_PERSISTENCE_t

The enum holding the possible firmware update persistence types.

Enumerator
PEAK_FIRMWARE_UPDATE_PERSISTENCE_NONE
PEAK_FIRMWARE_UPDATE_PERSISTENCE_FULL

PEAK_FIRMWARE_UPDATE_STEP_t

enum PEAK_FIRMWARE_UPDATE_STEP_t

The enum holding the possible firmware update steps.

Enumerator
PEAK_FIRMWARE_UPDATE_STEP_CHECK_PRECONDITIONS
PEAK_FIRMWARE_UPDATE_STEP_ACQUIRE_UPDATE_DATA
PEAK_FIRMWARE_UPDATE_STEP_WRITE_FEATURE
PEAK_FIRMWARE_UPDATE_STEP_EXECUTE_FEATURE
PEAK_FIRMWARE_UPDATE_STEP_ASSERT_FEATURE
PEAK_FIRMWARE_UPDATE_STEP_UPLOAD_FILE
PEAK_FIRMWARE_UPDATE_STEP_RESET_DEVICE

PEAK_FIRMWARE_UPDATE_VERSION_STYLE_t

enum PEAK_FIRMWARE_UPDATE_VERSION_STYLE_t

The enum holding the possible firmware update version styles.

Enumerator
PEAK_FIRMWARE_UPDATE_VERSION_STYLE_DOTTED
PEAK_FIRMWARE_UPDATE_VERSION_STYLE_SEMANTIC

PEAK_NODE_ACCESS_STATUS_t

enum PEAK_NODE_ACCESS_STATUS_t

The enum holding the possible node access status types.

Enumerator
PEAK_NODE_ACCESS_STATUS_NOT_IMPLEMENTED
PEAK_NODE_ACCESS_STATUS_NOT_AVAILABLE
PEAK_NODE_ACCESS_STATUS_WRITE_ONLY
PEAK_NODE_ACCESS_STATUS_READ_ONLY
PEAK_NODE_ACCESS_STATUS_READ_WRITE

PEAK_NODE_CACHE_USE_POLICY_t

enum PEAK_NODE_CACHE_USE_POLICY_t

The enum holding the possible node cache use policies.

Enumerator
PEAK_NODE_CACHE_USE_POLICY_USE_CACHE
PEAK_NODE_CACHE_USE_POLICY_IGNORE_CACHE

PEAK_NODE_CACHING_MODE_t

enum PEAK_NODE_CACHING_MODE_t

The enum holding the possible node caching modes.

Enumerator
PEAK_NODE_CACHING_MODE_NO_CACHE
PEAK_NODE_CACHING_MODE_WRITE_THROUGH
PEAK_NODE_CACHING_MODE_WRITE_AROUND

PEAK_NODE_DISPLAY_NOTATION_t

enum PEAK_NODE_DISPLAY_NOTATION_t

The enum holding the possible node display notations.

Enumerator
PEAK_NODE_DISPLAY_NOTATION_AUTOMATIC
PEAK_NODE_DISPLAY_NOTATION_FIXED
PEAK_NODE_DISPLAY_NOTATION_SCIENTIFIC

PEAK_NODE_INCREMENT_TYPE_t

enum PEAK_NODE_INCREMENT_TYPE_t

The enum holding the possible node increment types.

Enumerator
PEAK_NODE_INCREMENT_TYPE_NO_INCREMENT
PEAK_NODE_INCREMENT_TYPE_FIXED_INCREMENT
PEAK_NODE_INCREMENT_TYPE_LIST_INCREMENT

PEAK_NODE_NAMESPACE_t

enum PEAK_NODE_NAMESPACE_t

The enum holding the possible node namespaces.

Enumerator
PEAK_NODE_NAMESPACE_CUSTOM
PEAK_NODE_NAMESPACE_STANDARD

PEAK_NODE_REPRESENTATION_t

enum PEAK_NODE_REPRESENTATION_t

The enum holding the possible node representations.

Enumerator
PEAK_NODE_REPRESENTATION_LINEAR
PEAK_NODE_REPRESENTATION_LOGARITHMIC
PEAK_NODE_REPRESENTATION_BOOLEAN
PEAK_NODE_REPRESENTATION_PURE_NUMBER
PEAK_NODE_REPRESENTATION_HEX_NUMBER
PEAK_NODE_REPRESENTATION_IP4_ADDRESS
PEAK_NODE_REPRESENTATION_MAC_ADDRESS

PEAK_NODE_TYPE_t

enum PEAK_NODE_TYPE_t

The enum holding the possible node types.

Enumerator
PEAK_NODE_TYPE_INTEGER
PEAK_NODE_TYPE_BOOLEAN
PEAK_NODE_TYPE_COMMAND
PEAK_NODE_TYPE_FLOAT
PEAK_NODE_TYPE_STRING
PEAK_NODE_TYPE_REGISTER
PEAK_NODE_TYPE_CATEGORY
PEAK_NODE_TYPE_ENUMERATION
PEAK_NODE_TYPE_ENUMERATION_ENTRY

PEAK_NODE_VISIBILITY_t

enum PEAK_NODE_VISIBILITY_t

The enum holding the possible node visibility types.

Enumerator
PEAK_NODE_VISIBILITY_BEGINNER
PEAK_NODE_VISIBILITY_EXPERT
PEAK_NODE_VISIBILITY_GURU
PEAK_NODE_VISIBILITY_INVISIBLE

PEAK_PIXEL_FORMAT_NAMESPACE_t

enum PEAK_PIXEL_FORMAT_NAMESPACE_t

The enum holding the possible pixel format namespaces.

Enumerator
PEAK_PIXEL_FORMAT_NAMESPACE_GEV
PEAK_PIXEL_FORMAT_NAMESPACE_IIDC
PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_16_BIT
PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_32_BIT
PEAK_PIXEL_FORMAT_NAMESPACE_CUSTOM

PEAK_PORT_URL_SCHEME_t

enum PEAK_PORT_URL_SCHEME_t

The enum holding the possible port URL scheme types.

Enumerator
PEAK_PORT_URL_SCHEME_LOCAL
PEAK_PORT_URL_SCHEME_HTTP
PEAK_PORT_URL_SCHEME_FILE
PEAK_PORT_URL_SCHEME_CUSTOM

PEAK_RETURN_CODE_t

enum PEAK_RETURN_CODE_t

The enum holding the possible function return codes.

Enumerator
PEAK_RETURN_CODE_SUCCESS
PEAK_RETURN_CODE_ERROR
PEAK_RETURN_CODE_NOT_INITIALIZED
PEAK_RETURN_CODE_ABORTED
PEAK_RETURN_CODE_BAD_ACCESS
PEAK_RETURN_CODE_BAD_ALLOC
PEAK_RETURN_CODE_BUFFER_TOO_SMALL
PEAK_RETURN_CODE_INVALID_ADDRESS
PEAK_RETURN_CODE_INVALID_ARGUMENT
PEAK_RETURN_CODE_INVALID_CAST
PEAK_RETURN_CODE_INVALID_HANDLE
PEAK_RETURN_CODE_NOT_FOUND
PEAK_RETURN_CODE_OUT_OF_RANGE
PEAK_RETURN_CODE_TIMEOUT
PEAK_RETURN_CODE_NOT_AVAILABLE
PEAK_RETURN_CODE_NOT_IMPLEMENTED
PEAK_RETURN_CODE_CTI_LOADING_ERROR
PEAK_RETURN_CODE_IO
PEAK_RETURN_CODE_NO_DATA

Function Documentation

PEAK_BooleanNode_GetValue()

PEAK_C_API PEAK_BooleanNode_GetValue	(	PEAK_BOOLEAN_NODE_HANDLE	booleanNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		PEAK_BOOL8 *	value )

Asks the given boolean node for its value.

Parameters

[in]	booleanNodeHandle	The boolean node.
[in]	cacheUsePolicy	The cache use policy.
[out]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT value is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE booleanNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BooleanNode_SetValue()

PEAK_C_API PEAK_BooleanNode_SetValue	(	PEAK_BOOLEAN_NODE_HANDLE	booleanNodeHandle,
		PEAK_BOOL8	value )

Tells the given boolean node to set the given value.

Parameters

[in]	booleanNodeHandle	The boolean node.
[in]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE booleanNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BooleanNode_ToNode()

PEAK_C_API PEAK_BooleanNode_ToNode	(	PEAK_BOOLEAN_NODE_HANDLE	booleanNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given boolean node to a node.

Parameters

[in]	booleanNodeHandle	The boolean node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE booleanNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetBasePtr()

PEAK_C_API PEAK_Buffer_GetBasePtr	(	PEAK_BUFFER_HANDLE	bufferHandle,
		void **	basePtr )

Asks the given buffer for its base pointer.

Parameters

[in]	bufferHandle	The buffer.
[out]	basePtr	The base pointer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT basePtr is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetChunk()

PEAK_C_API PEAK_Buffer_GetChunk	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t	index,
		PEAK_BUFFER_CHUNK_HANDLE *	bufferChunkHandle )

Asks the given buffer for the chunk with the given index.

Parameters

[in]	bufferHandle	The buffer.
[in]	index	The index.
[out]	bufferChunkHandle	The chunk being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferChunkHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetChunkLayoutID()

PEAK_C_API PEAK_Buffer_GetChunkLayoutID	(	PEAK_BUFFER_HANDLE	bufferHandle,
		uint64_t *	chunkLayoutId )

Asks the given buffer for its chunk layout ID.

Parameters

[in]	bufferHandle	The buffer.
[out]	chunkLayoutId	The chunk layout ID.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT chunkLayoutId is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetDeliveredChunkPayloadSize()

PEAK_C_API PEAK_Buffer_GetDeliveredChunkPayloadSize	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	deliveredChunkPayloadSize )

Asks the given buffer for its delivered chunk payload size.

Parameters

[in]	bufferHandle	The buffer.
[out]	deliveredChunkPayloadSize	The delivered chunk payload size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deliveredChunkPayloadSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetDeliveredDataSize()

PEAK_C_API PEAK_Buffer_GetDeliveredDataSize	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	deliveredDataSize )

Asks the given buffer for its delivered data size.

Parameters

[in]	bufferHandle	The buffer.
[out]	deliveredDataSize	The delivered data size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deliveredDataSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetDeliveredImageHeight()

PEAK_C_API PEAK_Buffer_GetDeliveredImageHeight	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	deliveredImageHeight )

Asks the given buffer for its delivered image height.

Parameters

[in]	bufferHandle	The buffer.
[out]	deliveredImageHeight	The delivered image height.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deliveredImageHeight is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetExpectedDataSize()

PEAK_C_API PEAK_Buffer_GetExpectedDataSize	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	expectedDataSize )

Asks the given buffer for its expected data size.

Parameters

[in]	bufferHandle	The buffer.
[out]	expectedDataSize	The expected data size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT expectedDataSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetFileName()

PEAK_C_API PEAK_Buffer_GetFileName	(	PEAK_BUFFER_HANDLE	bufferHandle,
		char *	fileName,
		size_t *	fileNameSize )

Asks the given buffer for its file name.

Parameters

[in]	bufferHandle	The buffer.
[out]	fileName	The file name.
[in,out]	fileNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL fileNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetFrameID()

PEAK_C_API PEAK_Buffer_GetFrameID	(	PEAK_BUFFER_HANDLE	bufferHandle,
		uint64_t *	frameId )

Asks the given buffer for its frame ID.

Parameters

[in]	bufferHandle	The buffer.
[out]	frameId	The frame ID.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT frameId is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetHasChunks()

PEAK_C_API PEAK_Buffer_GetHasChunks	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	hasChunks )

Asks the given buffer whether it has chunks.

Parameters

[in]	bufferHandle	The buffer.
[out]	hasChunks	A flag telling whether the buffer has chunks.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasChunks is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetHasImage()

PEAK_C_API PEAK_Buffer_GetHasImage	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	hasImage )

Asks the given buffer whether it is has an image.

Parameters

[in]	bufferHandle	The buffer.
[out]	hasImage	A flag telling whether the buffer has an image.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasImage is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetHasNewData()

PEAK_C_API PEAK_Buffer_GetHasNewData	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	hasNewData )

Asks the given buffer whether it has new data since the last delivery.

Parameters

[in]	bufferHandle	The buffer.
[out]	hasNewData	A flag telling whether the buffer has new data.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasNewData is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetHasParts()

PEAK_C_API PEAK_Buffer_GetHasParts	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	hasParts )

Asks the given buffer whether it has parts.

Parameters

[in]	bufferHandle	The buffer.
[out]	hasParts	A flag telling whether the buffer has parts.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasParts is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7.4

PEAK_Buffer_GetHeight()

PEAK_C_API PEAK_Buffer_GetHeight	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	height )

Asks the given buffer for its height.

Parameters

[in]	bufferHandle	The buffer.
[out]	height	The height.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT height is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetImageOffset()

PEAK_C_API PEAK_Buffer_GetImageOffset	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	imageOffset )

Asks the given buffer for its image offset.

Parameters

[in]	bufferHandle	The buffer.
[out]	imageOffset	The image offset.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT imageOffset is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetInfo()

PEAK_C_API PEAK_Buffer_GetInfo	(	PEAK_BUFFER_HANDLE	bufferHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given buffer for an information based on a specific command.

Parameters

[in]	bufferHandle	The buffer.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetIsAcquiring()

PEAK_C_API PEAK_Buffer_GetIsAcquiring	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	isAcquiring )

Asks the given buffer whether it is acquiring.

Parameters

[in]	bufferHandle	The buffer.
[out]	isAcquiring	A flag telling whether the buffer is acquiring.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isAcquiring is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetIsIncomplete()

PEAK_C_API PEAK_Buffer_GetIsIncomplete	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	isIncomplete )

Asks the given buffer whether it is incomplete.

Parameters

[in]	bufferHandle	The buffer.
[out]	isIncomplete	A flag telling whether the buffer is incomplete.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isIncomplete is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetIsQueued()

PEAK_C_API PEAK_Buffer_GetIsQueued	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	isQueued )

Asks the given buffer whether it is queued.

Parameters

[in]	bufferHandle	The buffer.
[out]	isQueued	A flag telling whether the buffer is queued.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isQueued is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetNumChunks()

PEAK_C_API PEAK_Buffer_GetNumChunks	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	numChunks )

Asks the given buffer for its number of chunks.

Parameters

[in]	bufferHandle	The buffer.
[out]	numChunks	The number of chunks.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numChunks is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetNumParts()

PEAK_C_API PEAK_Buffer_GetNumParts	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	numParts )

Asks the given buffer for its number of parts.

Parameters

[in]	bufferHandle	The buffer.
[out]	numParts	The number of parts.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numParts is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetPart()

PEAK_C_API PEAK_Buffer_GetPart	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t	index,
		PEAK_BUFFER_PART_HANDLE *	bufferPartHandle )

Asks the given buffer for the part with the given index.

Parameters

[in]	bufferHandle	The buffer.
[in]	index	The index.
[out]	bufferPartHandle	The part being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferPartHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetPayloadType()

PEAK_C_API PEAK_Buffer_GetPayloadType	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BUFFER_PAYLOAD_TYPE *	payloadType )

Asks the given buffer for its payload type.

Parameters

[in]	bufferHandle	The buffer.
[out]	payloadType	The payload type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT payloadType is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetPixelEndianness()

PEAK_C_API PEAK_Buffer_GetPixelEndianness	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_ENDIANNESS *	pixelEndianness )

Asks the given buffer for its pixel endianness.

Parameters

[in]	bufferHandle	The buffer.
[out]	pixelEndianness	The pixel endianness.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT pixelEndianness is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetPixelFormat()

PEAK_C_API PEAK_Buffer_GetPixelFormat	(	PEAK_BUFFER_HANDLE	bufferHandle,
		uint64_t *	pixelFormat )

Asks the given buffer for its pixel format.

Parameters

[in]	bufferHandle	The buffer.
[out]	pixelFormat	The pixel format.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT pixelFormat is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetPixelFormatNamespace()

PEAK_C_API PEAK_Buffer_GetPixelFormatNamespace	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_PIXEL_FORMAT_NAMESPACE *	pixelFormatNamespace )

Asks the given buffer for its pixel format namespace.

Parameters

[in]	bufferHandle	The buffer.
[out]	pixelFormatNamespace	The pixel format namespace.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT pixelFormatNamespace is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetSize()

PEAK_C_API PEAK_Buffer_GetSize	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	size )

Asks the given buffer for its size.

Parameters

[in]	bufferHandle	The buffer.
[out]	size	The size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT size is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetTimestamp_ns()

PEAK_C_API PEAK_Buffer_GetTimestamp_ns	(	PEAK_BUFFER_HANDLE	bufferHandle,
		uint64_t *	timestamp_ns )

Asks the given buffer for its timestamp in nanoseconds.

Parameters

[in]	bufferHandle	The buffer.
[out]	timestamp_ns	The timestamp in nanoseconds.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT timestamp_ns is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetTimestamp_ticks()

PEAK_C_API PEAK_Buffer_GetTimestamp_ticks	(	PEAK_BUFFER_HANDLE	bufferHandle,
		uint64_t *	timestamp_ticks )

Asks the given buffer for its timestamp in ticks.

Parameters

[in]	bufferHandle	The buffer.
[out]	timestamp_ticks	The timestamp in ticks.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT timestamp_ticks is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetTLType()

PEAK_C_API PEAK_Buffer_GetTLType	(	PEAK_BUFFER_HANDLE	bufferHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given buffer for its TL type.

Parameters

[in]	bufferHandle	The buffer.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetUserPtr()

PEAK_C_API PEAK_Buffer_GetUserPtr	(	PEAK_BUFFER_HANDLE	bufferHandle,
		void **	userPtr )

Asks the given buffer for its user pointer.

Parameters

[in]	bufferHandle	The buffer.
[out]	userPtr	The user pointer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT userPtr is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetWidth()

PEAK_C_API PEAK_Buffer_GetWidth	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	width )

Asks the given buffer for its width.

Parameters

[in]	bufferHandle	The buffer.
[out]	width	The width.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT width is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetXOffset()

PEAK_C_API PEAK_Buffer_GetXOffset	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	xOffset )

Asks the given buffer for its X offset.

Parameters

[in]	bufferHandle	The buffer.
[out]	xOffset	The X offset.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT xOffset is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetXPadding()

PEAK_C_API PEAK_Buffer_GetXPadding	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	xPadding )

Asks the given buffer for its X padding.

Parameters

[in]	bufferHandle	The buffer.
[out]	xPadding	The X padding.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT xPadding is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetYOffset()

PEAK_C_API PEAK_Buffer_GetYOffset	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	yOffset )

Asks the given buffer for its Y offset.

Parameters

[in]	bufferHandle	The buffer.
[out]	yOffset	The Y offset.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT yOffset is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_GetYPadding()

PEAK_C_API PEAK_Buffer_GetYPadding	(	PEAK_BUFFER_HANDLE	bufferHandle,
		size_t *	yPadding )

Asks the given buffer for its Y padding.

Parameters

[in]	bufferHandle	The buffer.
[out]	yPadding	The Y padding.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT yPadding is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_ToEventSupportingModule()

PEAK_C_API PEAK_Buffer_ToEventSupportingModule	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_EVENT_SUPPORTING_MODULE_HANDLE *	eventSupportingModuleHandle )

Casts the given buffer to an event-supporting module.

Parameters

[in]	bufferHandle	The buffer.
[out]	eventSupportingModuleHandle	The event-supporting module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventSupportingModuleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_ToModule()

PEAK_C_API PEAK_Buffer_ToModule	(	PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given buffer to a module.

Parameters

[in]	bufferHandle	The buffer.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_UpdateChunks()

PEAK_C_API PEAK_Buffer_UpdateChunks

(

PEAK_BUFFER_HANDLE

bufferHandle

)

Tells the given buffer to update its chunks.

Parameters

[in]

bufferHandle

The buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Buffer_UpdateParts()

PEAK_C_API PEAK_Buffer_UpdateParts

(

PEAK_BUFFER_HANDLE

bufferHandle

)

Tells the given buffer to update its parts.

Parameters

[in]

bufferHandle

The buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferChunk_Destruct()

PEAK_C_API PEAK_BufferChunk_Destruct

(

PEAK_BUFFER_CHUNK_HANDLE

bufferChunkHandle

)

Destroys the given buffer chunk.

Parameters

[in]

bufferChunkHandle

The buffer chunk.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferChunkHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5

PEAK_BufferChunk_GetBasePtr()

PEAK_C_API PEAK_BufferChunk_GetBasePtr	(	PEAK_BUFFER_CHUNK_HANDLE	bufferChunkHandle,
		void **	basePtr )

Asks the given buffer chunk for its base pointer.

Parameters

[in]	bufferChunkHandle	The buffer chunk.
[out]	basePtr	The base pointer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferChunkHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT basePtr is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferChunk_GetID()

PEAK_C_API PEAK_BufferChunk_GetID	(	PEAK_BUFFER_CHUNK_HANDLE	bufferChunkHandle,
		uint64_t *	id )

Asks the given buffer chunk for its ID.

Parameters

[in]	bufferChunkHandle	The buffer chunk.
[out]	id	The ID.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferChunkHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT id is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferChunk_GetParentBuffer()

PEAK_C_API PEAK_BufferChunk_GetParentBuffer	(	PEAK_BUFFER_CHUNK_HANDLE	bufferChunkHandle,
		PEAK_BUFFER_HANDLE *	bufferHandle )

Asks the given buffer chunk for its parent buffer.

Parameters

[in]	bufferChunkHandle	The buffer chunk.
[out]	bufferHandle	The parent buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferChunkHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferChunk_GetSize()

PEAK_C_API PEAK_BufferChunk_GetSize	(	PEAK_BUFFER_CHUNK_HANDLE	bufferChunkHandle,
		size_t *	size )

Asks the given buffer chunk for its size.

Parameters

[in]	bufferChunkHandle	The buffer chunk.
[out]	size	The size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferChunkHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT size is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_Destruct()

PEAK_C_API PEAK_BufferPart_Destruct

(

PEAK_BUFFER_PART_HANDLE

bufferPartHandle

)

Destroys the given buffer part.

Parameters

[in]

bufferPartHandle

The buffer part.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.5

PEAK_BufferPart_GetBasePtr()

PEAK_C_API PEAK_BufferPart_GetBasePtr	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		void **	basePtr )

Asks the given buffer part for its base pointer.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	basePtr	The base pointer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT basePtr is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetDeliveredImageHeight()

PEAK_C_API PEAK_BufferPart_GetDeliveredImageHeight	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	deliveredImageHeight )

Asks the given buffer part for its delivered image height.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	deliveredImageHeight	The delivered image height.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deliveredImageHeight is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetFormat()

PEAK_C_API PEAK_BufferPart_GetFormat	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		uint64_t *	format )

Asks the given buffer part for its format.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	format	The format.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT format is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetFormatNamespace()

PEAK_C_API PEAK_BufferPart_GetFormatNamespace	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		uint64_t *	formatNamespace )

Asks the given buffer part for its format namespace.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	formatNamespace	The formatNamespace.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT formatNamespace is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetHeight()

PEAK_C_API PEAK_BufferPart_GetHeight	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	height )

Asks the given buffer part for its height.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	height	The height.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT height is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetInfo()

PEAK_C_API PEAK_BufferPart_GetInfo	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given buffer part for an information based on a specific command.

Parameters

[in]	bufferPartHandle	The buffer part.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetParentBuffer()

PEAK_C_API PEAK_BufferPart_GetParentBuffer	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		PEAK_BUFFER_HANDLE *	bufferHandle )

Asks the given buffer part for its parent buffer.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	bufferHandle	The parent buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT parentBuffer is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetSize()

PEAK_C_API PEAK_BufferPart_GetSize	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	size )

Asks the given buffer part for its size.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	size	The size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT size is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetSourceID()

PEAK_C_API PEAK_BufferPart_GetSourceID	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		uint64_t *	sourceId )

Asks the given buffer part for its source ID.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	sourceId	The source ID.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT sourceId is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetType()

PEAK_C_API PEAK_BufferPart_GetType	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		PEAK_BUFFER_PART_TYPE *	type )

Asks the given buffer part for its type.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	type	The type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT type is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetWidth()

PEAK_C_API PEAK_BufferPart_GetWidth	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	width )

Asks the given buffer part for its width.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	width	The width.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT width is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetXOffset()

PEAK_C_API PEAK_BufferPart_GetXOffset	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	xOffset )

Asks the given buffer part for its X offset.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	xOffset	The X offset.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT xOffset is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetXPadding()

PEAK_C_API PEAK_BufferPart_GetXPadding	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	xPadding )

Asks the given buffer part for its X padding.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	xPadding	The X padding.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT xPadding is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_BufferPart_GetYOffset()

PEAK_C_API PEAK_BufferPart_GetYOffset	(	PEAK_BUFFER_PART_HANDLE	bufferPartHandle,
		size_t *	yOffset )

Asks the given buffer part for its Y offset.

Parameters

[in]	bufferPartHandle	The buffer part.
[out]	yOffset	The Y offset.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferPartHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT yOffset is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CategoryNode_GetNumSubNodes()

PEAK_C_API PEAK_CategoryNode_GetNumSubNodes	(	PEAK_CATEGORY_NODE_HANDLE	categoryNodeHandle,
		size_t *	numSubNodes )

Asks the given category node for its number of sub nodes.

Parameters

[in]	categoryNodeHandle	The category node.
[out]	numSubNodes	The number of sub nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE categoryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numSubNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CategoryNode_GetSubNode()

PEAK_C_API PEAK_CategoryNode_GetSubNode	(	PEAK_CATEGORY_NODE_HANDLE	categoryNodeHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	nodeHandle )

Asks the given category node for the sub node with the given index.

Parameters

[in]	categoryNodeHandle	The category node.
[in]	index	The index.
[out]	nodeHandle	The sub node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE categoryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CategoryNode_ToNode()

PEAK_C_API PEAK_CategoryNode_ToNode	(	PEAK_CATEGORY_NODE_HANDLE	categoryNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given category node to a node.

Parameters

[in]	categoryNodeHandle	The category node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE categoryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CommandNode_Execute()

PEAK_C_API PEAK_CommandNode_Execute

(

PEAK_COMMAND_NODE_HANDLE

commandNodeHandle

)

Tells the given command node to execute its associated command.

Parameters

[in]

commandNodeHandle

The command node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE commandNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CommandNode_GetIsDone()

PEAK_C_API PEAK_CommandNode_GetIsDone	(	PEAK_COMMAND_NODE_HANDLE	commandNodeHandle,
		PEAK_BOOL8 *	isDone )

Asks the given command node whether its associated command is done.

Parameters

[in]	commandNodeHandle	The command node.
[out]	isDone	A flag telling whether the command is done.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT isDone is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE commandNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CommandNode_ToNode()

PEAK_C_API PEAK_CommandNode_ToNode	(	PEAK_COMMAND_NODE_HANDLE	commandNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given command node to a node.

Parameters

[in]	commandNodeHandle	The command node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE commandNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CommandNode_WaitUntilDone()

PEAK_C_API PEAK_CommandNode_WaitUntilDone	(	PEAK_COMMAND_NODE_HANDLE	commandNodeHandle,
		uint64_t	waitTimeout_ms )

Waits (blocking) until the previously executed command is finished, i.e. PEAK_CommandNode_GetIsDone() returns true.

Parameters

[in]	commandNodeHandle	The command node.
[in]	waitTimeout_ms	The waiting time for the stop criterion.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_TIMEOUT The wait timed out

PEAK_RETURN_CODE_INVALID_HANDLE commandNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_CommandNode_WaitUntilDoneInfinite()

PEAK_C_API PEAK_CommandNode_WaitUntilDoneInfinite

(

PEAK_COMMAND_NODE_HANDLE

commandNodeHandle

)

Waits (blocking) without timeout until the previously executed command is finished, i.e. PEAK_CommandNode_GetIsDone() returns true.

Parameters

[in]

commandNodeHandle

The command node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE commandNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_AllocAndAnnounceBuffer()

PEAK_C_API PEAK_DataStream_AllocAndAnnounceBuffer	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t	bufferSize,
		void *	userPtr,
		PEAK_BUFFER_HANDLE *	bufferHandle )

Tells the given data stream to allocate and announce a buffer with the given size.

The size of this buffer must be equal to the value of the "PayloadSize" node.

To ensure that the payload size does not change while the acquisition is running, it is strongly recommended to set the integer node "TLParamsLocked" to a value of 1. Setting the "TLParamsLocked" node to 1 locks all writable nodes in the XML tree that must not be modified during image acquisition.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	bufferSize	The size of the buffer in bytes.
[in]	userPtr	The user ptr.
[out]	bufferHandle	The handle being associated with the given buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_AnnounceBuffer()

PEAK_C_API PEAK_DataStream_AnnounceBuffer	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		void *	buffer,
		size_t	bufferSize,
		void *	userPtr,
		PEAK_BUFFER_REVOCATION_CALLBACK	revocationCallback,
		void *	callbackContext,
		PEAK_BUFFER_HANDLE *	bufferHandle )

Announces the given buffer at the given data stream.

The size of this buffer must be equal to the value of the "PayloadSize" node.

To ensure that the payload size does not change while the acquisition is running, it is strongly recommended to set the integer node "TLParamsLocked" to a value of 1. Setting the "TLParamsLocked" node to 1 locks all writable nodes in the XML tree that must not be modified during image acquisition.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	buffer	The buffer.
[in]	bufferSize	The size of the buffer in bytes.
[in]	userPtr	A pointer to user defined data, for identifying the buffer or attaching custom data to the buffer. Optional.
[in]	revocationCallback	The callback to call on revocation of the buffer. Optional.
[in]	callbackContext	The callback context. Optional.
[out]	bufferHandle	The handle being associated with the given buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT buffer and/or revocationCallback and/or bufferHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_Destruct()

PEAK_C_API PEAK_DataStream_Destruct

(

PEAK_DATA_STREAM_HANDLE

dataStreamHandle

)

Destroys the given data stream.

Parameters

[in]

dataStreamHandle

The data stream.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_Flush()

PEAK_C_API PEAK_DataStream_Flush	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_DATA_STREAM_FLUSH_MODE	flushMode )

Tells the given data stream to flush its queues using the given mode.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	flushMode	The flush mode.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_FlushPendingKillWaits()

PEAK_C_API PEAK_DataStream_FlushPendingKillWaits

(

PEAK_DATA_STREAM_HANDLE

dataStreamHandle

)

Flushes the KillWait queue.

This function clears all queued KillWaits, preventing subsequent calls to PEAK_DataStream_WaitForFinishedBuffer from throwing a peak::core::AbortedException.

Calls to PEAK_DataStream_WaitForFinishedBuffer that are currently waiting will be aborted and throw a peak::core::AbortedException.

Attention

This function can usually only be used when the acquisition is stopped, depending on the transport layer in use.

Parameters

[in]

dataStreamHandle

The data stream.

Returns

PEAK_RETURN_CODE_SUCCESS If everything was successful.

PEAK_RETURN_CODE_INVALID_HANDLE If the dataStreamHandle is invalid.

PEAK_RETURN_CODE_BAD_ACCESS If the acquisition is running and must be stopped.

PEAK_RETURN_CODE_ERROR If an internal error occurs.

Since

1.11

PEAK_DataStream_GetBufferAlignment()

PEAK_C_API PEAK_DataStream_GetBufferAlignment	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	bufferAlignment )

Asks the given data stream for its buffer alignment.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	bufferAlignment	The buffer alignment in bytes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferAlignment is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetDefinesPayloadSize()

PEAK_C_API PEAK_DataStream_GetDefinesPayloadSize	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_BOOL8 *	definesPayloadSize )

Asks the given data stream whether it defines the payload size.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	definesPayloadSize	A flag telling whether the data stream defines the payload size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT definesPayloadSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetID()

PEAK_C_API PEAK_DataStream_GetID	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		char *	id,
		size_t *	idSize )

Asks the given data stream for its ID.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetInfo()

PEAK_C_API PEAK_DataStream_GetInfo	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given data stream for an information based on a specific command.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetIsGrabbing()

PEAK_C_API PEAK_DataStream_GetIsGrabbing	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_BOOL8 *	isGrabbing )

Asks the given data stream whether it is grabbing.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	isGrabbing	A flag telling whether the data stream is grabbing.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isGrabbing is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetKey()

PEAK_C_API PEAK_DataStream_GetKey	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		char *	key,
		size_t *	keySize )

Asks the given data stream for its key.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersAnnounced()

PEAK_C_API PEAK_DataStream_GetNumBuffersAnnounced	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	numBuffersAnnounced )

Asks the given data stream for its number of announced buffers.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersAnnounced	The number of announced buffers.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersAnnounced is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersAnnouncedMinRequired()

PEAK_C_API PEAK_DataStream_GetNumBuffersAnnouncedMinRequired	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	numBuffersAnnouncedMinRequired )

Asks the given data stream for its minimum required number of announced buffers.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersAnnouncedMinRequired	The minimum required number of announced buffers.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersAnnouncedMinRequired is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersAwaitDelivery()

PEAK_C_API PEAK_DataStream_GetNumBuffersAwaitDelivery	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	numBuffersAwaitDelivery )

Asks the given data stream for its number of buffers awaiting delivery.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersAwaitDelivery	The number of buffers awaiting delivery.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersAwaitDelivery is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersDelivered()

PEAK_C_API PEAK_DataStream_GetNumBuffersDelivered	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		uint64_t *	numBuffersDelivered )

Asks the given data stream for its number of delivered buffers.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersDelivered	The number of delivered buffers.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersDelivered is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersQueued()

PEAK_C_API PEAK_DataStream_GetNumBuffersQueued	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	numBuffersQueued )

Asks the given data stream for its number of queued buffers.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersQueued	The number of queued buffers.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersQueued is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumBuffersStarted()

PEAK_C_API PEAK_DataStream_GetNumBuffersStarted	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		uint64_t *	numBuffersStarted )

Asks the given data stream for its number of started buffers.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numBuffersStarted	The number of started buffers.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numBuffersStarted is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumChunksPerBufferMax()

PEAK_C_API PEAK_DataStream_GetNumChunksPerBufferMax	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	numChunksPerBufferMax )

Asks the given data stream for its maximum number of chunks per buffer.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numChunksPerBufferMax	The maximum number of chunks per buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numChunksPerBufferMax is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetNumUnderruns()

PEAK_C_API PEAK_DataStream_GetNumUnderruns	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		uint64_t *	numUnderruns )

Asks the given data stream for its number of underruns.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	numUnderruns	The number of underruns.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numUnderruns is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetParentDevice()

PEAK_C_API PEAK_DataStream_GetParentDevice	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_DEVICE_HANDLE *	deviceHandle )

Asks the given data stream for its parent device.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	deviceHandle	The parent device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deviceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetPayloadSize()

PEAK_C_API PEAK_DataStream_GetPayloadSize	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		size_t *	payloadSize )

Asks the given data stream for its payload size.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	payloadSize	The payload size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT payloadSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_GetTLType()

PEAK_C_API PEAK_DataStream_GetTLType	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given data stream for its TL type.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_KillWait()

PEAK_C_API PEAK_DataStream_KillWait

(

PEAK_DATA_STREAM_HANDLE

dataStreamHandle

)

Tells the data stream to kill one call to PEAK_DataStream_WaitForFinishedBuffer.

Kills one call to PEAK_DataStream_WaitForFinishedBuffer or queues the kill request to be applied to the next call. Calling PEAK_DataStream_KillWait multiple times will queue multiple kills.

Attention

Pending kills stay queued even if the acquisition is stopped and restarted. They can only be cleared by closing the datastream or calling FlushPendingKillWaits.

Queueing kills may be prevented by letting your acquisition thread run until PEAK_DataStream_WaitForFinishedBuffer returns with AbortedException and calling PEAK_DataStream_KillWait only once and only if the acquisition is running, which may be checked using the PEAK_DataStream_GetIsGrabbing function.

Parameters

[in]

dataStreamHandle

The data stream.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_QueueBuffer()

PEAK_C_API PEAK_DataStream_QueueBuffer	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_BUFFER_HANDLE	bufferHandle )

Tells the given data stream to queue the given buffer.

Queueing a given buffer makes it available to be used by the acquisition engine for receiving new data.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	bufferHandle	The buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle and/or bufferHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_RevokeBuffer()

PEAK_C_API PEAK_DataStream_RevokeBuffer	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_BUFFER_HANDLE	bufferHandle )

Tells the given data stream to revoke the given buffer.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	bufferHandle	The buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle and/or bufferHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_StartAcquisition()

PEAK_C_API PEAK_DataStream_StartAcquisition	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_ACQUISITION_START_MODE	startMode,
		uint64_t	numToAcquire )

Tells the given data stream to start the acquisition using the given mode and to acquire the given number of buffers.

Starts the acquisition engine on the host side. The acquisition on the remote device needs to be started separately using the "AcquisitionStart" command node. Once numToAcquire buffers are received all subsequent buffers will be discarded. PEAK_DataStream_StopAcquisition still has to be called explicitly.

The acquisition engine depends on the payload size value not changing between announcing the buffers to the data stream and while the acquisition is running. For information on how to ensure this can't happen, see PEAK_DataStream_AnnounceBuffer.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	startMode	The acquisition start mode.
[in]	numToAcquire	The number of frames to be acquired.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_StartAcquisitionInfinite()

PEAK_C_API PEAK_DataStream_StartAcquisitionInfinite	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_ACQUISITION_START_MODE	startMode )

Tells the given data stream to start the acquisition using the given mode.

Starts the acquisition engine on the host side. The acquisition on the remote device needs to be started separately using the "AcquisitionStart" command node.

The acquisition engine depends on the payload size value not changing between announcing the buffers to the data stream and while the acquisition is running. For information on how to ensure this can't happen, see PEAK_DataStream_AnnounceBuffer.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	startMode	The acquisition start mode.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_StopAcquisition()

PEAK_C_API PEAK_DataStream_StopAcquisition	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_ACQUISITION_STOP_MODE	stopMode )

Tells the given data stream to stop the acquisition using the given mode.

Parameters

[in]	dataStreamHandle	The data stream.
[in]	stopMode	The acquisition stop mode.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_ToEventSupportingModule()

PEAK_C_API PEAK_DataStream_ToEventSupportingModule	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_EVENT_SUPPORTING_MODULE_HANDLE *	eventSupportingModuleHandle )

Casts the given data stream to an event-supporting module.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	eventSupportingModuleHandle	The event-supporting module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventSupportingModuleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_ToModule()

PEAK_C_API PEAK_DataStream_ToModule	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given data stream to a module.

Parameters

[in]	dataStreamHandle	The data stream.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStream_WaitForFinishedBuffer()

PEAK_C_API PEAK_DataStream_WaitForFinishedBuffer	(	PEAK_DATA_STREAM_HANDLE	dataStreamHandle,
		uint64_t	timeout_ms,
		PEAK_BUFFER_HANDLE *	bufferHandle )

Blocking wait for a finished Buffer.

Block and wait for the next buffer to be received or until the supplied timeout is exceeded. In order to wait indefinitely use INFINITE_TIMEOUT.

A call to WaitForFinishedBuffer can be aborted immediately and at any time by calling KillWait from another thread, resulting in an AbortedException being thrown. This is especially useful when using INFINITE_TIMEOUT.

A buffer returned by WaitForFinishedBuffer is guaranteed to remain untouched by the acquisition engine, until it has been re-queued using QueueBuffer. Depending on the time it takes the application to process the image, it may be beneficial to copy the buffer data, re-queue the buffer and to process the copy.

Attention

If buffers are not re-queued using QueueBuffer in time and no more buffers are available to the acquisition engine, no buffers will be received!

Parameters

[in]	dataStreamHandle	The data stream.
[in]	timeout_ms	The timeout.
[out]	bufferHandle	The finished buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bufferHandle is a null pointer

PEAK_RETURN_CODE_ABORTED The wait was aborted

PEAK_RETURN_CODE_TIMEOUT The wait timed out

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStreamDescriptor_GetKey()

PEAK_C_API PEAK_DataStreamDescriptor_GetKey	(	PEAK_DATA_STREAM_DESCRIPTOR_HANDLE	dataStreamDescriptorHandle,
		char *	key,
		size_t *	keySize )

Asks the given data stream descriptor for its key.

Parameters

[in]	dataStreamDescriptorHandle	The data stream descriptor.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStreamDescriptor_GetParentDevice()

PEAK_C_API PEAK_DataStreamDescriptor_GetParentDevice	(	PEAK_DATA_STREAM_DESCRIPTOR_HANDLE	dataStreamDescriptorHandle,
		PEAK_DEVICE_HANDLE *	deviceHandle )

Asks the given data stream descriptor for its parent device.

Parameters

[in]	dataStreamDescriptorHandle	The data stream descriptor.
[out]	deviceHandle	The parent device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deviceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStreamDescriptor_OpenDataStream()

PEAK_C_API PEAK_DataStreamDescriptor_OpenDataStream	(	PEAK_DATA_STREAM_DESCRIPTOR_HANDLE	dataStreamDescriptorHandle,
		PEAK_DATA_STREAM_HANDLE *	dataStreamHandle )

Opens the data stream being associated with the given data stream descriptor.

Parameters

[in]	dataStreamDescriptorHandle	The data stream descriptor.
[out]	dataStreamHandle	The data stream.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT dataStreamHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DataStreamDescriptor_ToModuleDescriptor()

PEAK_C_API PEAK_DataStreamDescriptor_ToModuleDescriptor	(	PEAK_DATA_STREAM_DESCRIPTOR_HANDLE	dataStreamDescriptorHandle,
		PEAK_MODULE_DESCRIPTOR_HANDLE *	moduleDescriptorHandle )

Casts the given data stream descriptor to a module descriptor.

Parameters

[in]	dataStreamDescriptorHandle	The data stream descriptor.
[out]	moduleDescriptorHandle	The module descriptor.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE dataStreamDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleDescriptorHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_Destruct()

PEAK_C_API PEAK_Device_Destruct

(

PEAK_DEVICE_HANDLE

deviceHandle

)

Delete the given device.

Parameters

[in]

deviceHandle

The device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetAccessStatus()

PEAK_C_API PEAK_Device_GetAccessStatus	(	PEAK_DEVICE_HANDLE	deviceHandle,
		PEAK_DEVICE_ACCESS_STATUS *	accessStatus )

Asks the given device for its access status.

Parameters

[in]	deviceHandle	The device.
[out]	accessStatus	The access status.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT accessStatus is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetDataStream()

PEAK_C_API PEAK_Device_GetDataStream	(	PEAK_DEVICE_HANDLE	deviceHandle,
		size_t	index,
		PEAK_DATA_STREAM_DESCRIPTOR_HANDLE *	dataStreamDescriptorHandle )

Asks the given device for the data stream descriptor with the given index.

Parameters

[in]	deviceHandle	The device.
[in]	index	The index.
[out]	dataStreamDescriptorHandle	The data stream descriptor being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT dataStreamDescriptorHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetDisplayName()

PEAK_C_API PEAK_Device_GetDisplayName	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given device for its display name.

Parameters

[in]	deviceHandle	The device.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetID()

PEAK_C_API PEAK_Device_GetID	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	id,
		size_t *	idSize )

Asks the given device for its ID.

Parameters

[in]	deviceHandle	The device.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetInfo()

PEAK_C_API PEAK_Device_GetInfo	(	PEAK_DEVICE_HANDLE	deviceHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given device for an information based on a specific command.

Parameters

[in]	deviceHandle	The device.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetKey()

PEAK_C_API PEAK_Device_GetKey	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	key,
		size_t *	keySize )

Asks the given device for its key.

Parameters

[in]	deviceHandle	The device.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetModelName()

PEAK_C_API PEAK_Device_GetModelName	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	modelName,
		size_t *	modelNameSize )

Asks the given device for its model name.

Parameters

[in]	deviceHandle	The device.
[out]	modelName	The model name.
[in,out]	modelNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT modelNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL modelNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetNumDataStreams()

PEAK_C_API PEAK_Device_GetNumDataStreams	(	PEAK_DEVICE_HANDLE	deviceHandle,
		size_t *	numDataStreams )

Asks the given device for its number of data streams.

Parameters

[in]	deviceHandle	The device.
[out]	numDataStreams	The number of data streams.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numDataStreams is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetParentInterface()

PEAK_C_API PEAK_Device_GetParentInterface	(	PEAK_DEVICE_HANDLE	deviceHandle,
		PEAK_INTERFACE_HANDLE *	interfaceHandle )

Asks the given device for its parent interface.

Parameters

[in]	deviceHandle	The device.
[out]	interfaceHandle	The parent interface.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT interfaceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetRemoteDevice()

PEAK_C_API PEAK_Device_GetRemoteDevice	(	PEAK_DEVICE_HANDLE	deviceHandle,
		PEAK_REMOTE_DEVICE_HANDLE *	remoteDeviceHandle )

Asks the given device for its remote device.

Parameters

[in]	deviceHandle	The device.
[out]	remoteDeviceHandle	The remote device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT remoteDeviceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetSerialNumber()

PEAK_C_API PEAK_Device_GetSerialNumber	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	serialNumber,
		size_t *	serialNumberSize )

Asks the given device for its serial number.

Parameters

[in]	deviceHandle	The device.
[out]	serialNumber	The serial number.
[in,out]	serialNumberSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT serialNumberSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL serialNumberSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetTimestampTickFrequency()

PEAK_C_API PEAK_Device_GetTimestampTickFrequency	(	PEAK_DEVICE_HANDLE	deviceHandle,
		uint64_t *	timestampTickFrequency )

Asks the given device for its timestamp tick frequency.

Parameters

[in]	deviceHandle	The device.
[out]	timestampTickFrequency	The timestamp tick frequency.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT timestampTickFrequency is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetTLType()

PEAK_C_API PEAK_Device_GetTLType	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given device for its TL type.

Parameters

[in]	deviceHandle	The device.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetUserDefinedName()

PEAK_C_API PEAK_Device_GetUserDefinedName	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	userDefinedName,
		size_t *	userDefinedNameSize )

Asks the given device for its user-defined name.

Parameters

[in]	deviceHandle	The device.
[out]	userDefinedName	The user-defined name.
[in,out]	userDefinedNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT userDefinedNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL userDefinedNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetVendorName()

PEAK_C_API PEAK_Device_GetVendorName	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	vendorName,
		size_t *	vendorNameSize )

Asks the given device for its vendor name.

Parameters

[in]	deviceHandle	The device.
[out]	vendorName	The vendor name.
[in,out]	vendorNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT vendorNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL vendorNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_GetVersion()

PEAK_C_API PEAK_Device_GetVersion	(	PEAK_DEVICE_HANDLE	deviceHandle,
		char *	version,
		size_t *	versionSize )

Asks the given device for its version.

Parameters

[in]	deviceHandle	The device.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_ToEventSupportingModule()

PEAK_C_API PEAK_Device_ToEventSupportingModule	(	PEAK_DEVICE_HANDLE	deviceHandle,
		PEAK_EVENT_SUPPORTING_MODULE_HANDLE *	eventSupportingModuleHandle )

Casts the given device to an event-supporting module.

Parameters

[in]	deviceHandle	The device.
[out]	eventSupportingModuleHandle	The event-supporting module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventSupportingModuleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Device_ToModule()

PEAK_C_API PEAK_Device_ToModule	(	PEAK_DEVICE_HANDLE	deviceHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given device to a module.

Parameters

[in]	deviceHandle	The device.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_AddInformationRoleToMonitoring()

PEAK_C_API PEAK_DeviceDescriptor_AddInformationRoleToMonitoring	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_INFORMATION_ROLE	informationRole )

Tells the given device descriptor to add the given information role to the monitoring.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	informationRole	The information role.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetAccessStatus()

PEAK_C_API PEAK_DeviceDescriptor_GetAccessStatus	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_ACCESS_STATUS *	accessStatus )

Asks the given device descriptor for its access status.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	accessStatus	The access status.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT accessStatus is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetDisplayName()

PEAK_C_API PEAK_DeviceDescriptor_GetDisplayName	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given device descriptor for its display name.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetInfo()

PEAK_C_API PEAK_DeviceDescriptor_GetInfo	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given device descriptor for an information based on a specific command.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetIsOpenable()

PEAK_C_API PEAK_DeviceDescriptor_GetIsOpenable	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_ACCESS_TYPE	accessType,
		PEAK_BOOL8 *	isOpenable )

Asks the given device descriptor whether the device can be opened with this specific access type.

If the device can be opened with a higher access type, it can also be opened with a lower access type.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	accessType	The access type.
[out]	isOpenable	A flag telling whether the given access type is available.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isOpenable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetIsOpenableExclusive()

PEAK_C_API PEAK_DeviceDescriptor_GetIsOpenableExclusive	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_BOOL8 *	isOpenable )

Asks the given device descriptor whether the device can be opened with exclusive access.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	isOpenable	A flag telling whether the device descriptor is openable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isOpenable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetKey()

PEAK_C_API PEAK_DeviceDescriptor_GetKey	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	key,
		size_t *	keySize )

Asks the given device descriptor for its key.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetModelName()

PEAK_C_API PEAK_DeviceDescriptor_GetModelName	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	modelName,
		size_t *	modelNameSize )

Asks the given device descriptor for its model name.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	modelName	The model name.
[in,out]	modelNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT modelNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL modelNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetMonitoringUpdateInterval()

PEAK_C_API PEAK_DeviceDescriptor_GetMonitoringUpdateInterval	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		uint64_t *	monitoringUpdateInterval_ms )

Asks the given device descriptor for its monitoring update interval.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	monitoringUpdateInterval_ms	The monitoring update interval.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT monitoringUpdateInterval_ms is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetParentInterface()

PEAK_C_API PEAK_DeviceDescriptor_GetParentInterface	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_INTERFACE_HANDLE *	interfaceHandle )

Asks the given device descriptor for its parent interface.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	interfaceHandle	The parent interface.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT interfaceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetSerialNumber()

PEAK_C_API PEAK_DeviceDescriptor_GetSerialNumber	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	serialNumber,
		size_t *	serialNumberSize )

Asks the given device descriptor for its serial number.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	serialNumber	The serial number.
[in,out]	serialNumberSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT serialNumberSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL serialNumberSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetTimestampTickFrequency()

PEAK_C_API PEAK_DeviceDescriptor_GetTimestampTickFrequency	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		uint64_t *	timestampTickFrequency )

Asks the given device descriptor for its timestamp tick frequency.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	timestampTickFrequency	The timestamp tick frequency.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT timestampTickFrequency is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetTLType()

PEAK_C_API PEAK_DeviceDescriptor_GetTLType	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given device descriptor for its TL type.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetUserDefinedName()

PEAK_C_API PEAK_DeviceDescriptor_GetUserDefinedName	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	userDefinedName,
		size_t *	userDefinedNameSize )

Asks the given device descriptor for its user-defined name.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	userDefinedName	The user-defined name.
[in,out]	userDefinedNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT userDefinedNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL userDefinedNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetVendorName()

PEAK_C_API PEAK_DeviceDescriptor_GetVendorName	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	vendorName,
		size_t *	vendorNameSize )

Asks the given device descriptor for its vendor name.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	vendorName	The vendor name.
[in,out]	vendorNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT vendorNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL vendorNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_GetVersion()

PEAK_C_API PEAK_DeviceDescriptor_GetVersion	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		char *	version,
		size_t *	versionSize )

Asks the given device descriptor for its version.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_IsInformationRoleMonitored()

PEAK_C_API PEAK_DeviceDescriptor_IsInformationRoleMonitored	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_INFORMATION_ROLE	informationRole,
		PEAK_BOOL8 *	isInformationRoleMonitored )

Asks the given device descriptor whether the given information role is monitored.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	informationRole	The information role.
[out]	isInformationRoleMonitored	A flag telling whether the given information role is monitored.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isInformationRoleMonitored is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_OpenDevice()

PEAK_C_API PEAK_DeviceDescriptor_OpenDevice	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_ACCESS_TYPE	accessType,
		PEAK_DEVICE_HANDLE *	deviceHandle )

Opens the device being associated with the given interface descriptor for the given access type.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	accessType	The access type to open the device with.
[out]	deviceHandle	The device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deviceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_RegisterInformationChangedCallback()

PEAK_C_API PEAK_DeviceDescriptor_RegisterInformationChangedCallback	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling changed information at the given device descriptor.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_RemoveInformationRoleFromMonitoring()

PEAK_C_API PEAK_DeviceDescriptor_RemoveInformationRoleFromMonitoring	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_INFORMATION_ROLE	informationRole )

Tells the given device descriptor to remove the given information role from the monitoring.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	informationRole	The information role.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_SetMonitoringUpdateInterval()

PEAK_C_API PEAK_DeviceDescriptor_SetMonitoringUpdateInterval	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		uint64_t	monitoringUpdateInterval_ms )

Tells the given device descriptor to set the given monitoring update interval.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	monitoringUpdateInterval_ms	The monitoring update interval.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_ToModuleDescriptor()

PEAK_C_API PEAK_DeviceDescriptor_ToModuleDescriptor	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_MODULE_DESCRIPTOR_HANDLE *	moduleDescriptorHandle )

Casts the given device descriptor to a module descriptor.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[out]	moduleDescriptorHandle	The module descriptor.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleDescriptorHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_DeviceDescriptor_UnregisterInformationChangedCallback()

PEAK_C_API PEAK_DeviceDescriptor_UnregisterInformationChangedCallback	(	PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE	callbackHandle )

Unregisters the information changed callback with the given handle from the given device descriptor.

Parameters

[in]	deviceDescriptorHandle	The device descriptor.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE deviceDescriptorHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationEntryNode_GetIsSelfClearing()

PEAK_C_API PEAK_EnumerationEntryNode_GetIsSelfClearing	(	PEAK_ENUMERATION_ENTRY_NODE_HANDLE	enumerationEntryNodeHandle,
		PEAK_BOOL8 *	isSelfClearing )

Asks the given enumeration entry node whether it is self clearing.

Parameters

[in]	enumerationEntryNodeHandle	The enumeration entry node.
[out]	isSelfClearing	A flag telling whether the enumeration entry node is self clearing.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationEntryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isSelfClearing is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationEntryNode_GetSymbolicValue()

PEAK_C_API PEAK_EnumerationEntryNode_GetSymbolicValue	(	PEAK_ENUMERATION_ENTRY_NODE_HANDLE	enumerationEntryNodeHandle,
		char *	symbolicValue,
		size_t *	symbolicValueSize )

Asks the given enumeration entry node for its symbolic value.

Parameters

[in]	enumerationEntryNodeHandle	The enumeration entry node.
[out]	symbolicValue	The symbolic value.
[in,out]	symbolicValueSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationEntryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolicValueSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL symbolicValueSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationEntryNode_GetValue()

PEAK_C_API PEAK_EnumerationEntryNode_GetValue	(	PEAK_ENUMERATION_ENTRY_NODE_HANDLE	enumerationEntryNodeHandle,
		int64_t *	value )

Asks the given enumeration entry node for its value.

Parameters

[in]	enumerationEntryNodeHandle	The enumeration entry node.
[out]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationEntryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT value is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationEntryNode_ToNode()

PEAK_C_API PEAK_EnumerationEntryNode_ToNode	(	PEAK_ENUMERATION_ENTRY_NODE_HANDLE	enumerationEntryNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given enumeration entry node to a node.

Parameters

[in]	enumerationEntryNodeHandle	The enumeration entry node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationEntryNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_FindEntryBySymbolicValue()

PEAK_C_API PEAK_EnumerationNode_FindEntryBySymbolicValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		const char *	symbolicValue,
		size_t	symbolicValueSize,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Tells the given enumeration node to find an entry with the given symbolic value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	symbolicValue	The symbolic value.
[in]	symbolicValueSize	The size of the symbolic value.
[out]	enumerationEntryNodeHandle	The found entry.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolicValue and/or enumerationEntryNodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no entry with the given symbolic value

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_FindEntryByValue()

PEAK_C_API PEAK_EnumerationNode_FindEntryByValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		int64_t	value,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Tells the given enumeration node to find an entry with the given value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	value	The value.
[out]	enumerationEntryNodeHandle	The found entry.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationEntryNodeHandle is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no entry with the given value

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_GetCurrentEntry()

PEAK_C_API PEAK_EnumerationNode_GetCurrentEntry	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Asks the given enumeration node for its current entry.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	cacheUsePolicy	The cache use policy.
[out]	enumerationEntryNodeHandle	The current entry.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationEntryNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_GetEntry()

PEAK_C_API PEAK_EnumerationNode_GetEntry	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		size_t	index,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Asks the given enumeration node for the entry with the given index.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	index	The index.
[out]	enumerationEntryNodeHandle	The entry being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationEntryNodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_GetHasEntryBySymbolicValue()

PEAK_C_API PEAK_EnumerationNode_GetHasEntryBySymbolicValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		const char *	symbolicValue,
		size_t	symbolicValueSize,
		PEAK_BOOL8 *	hasEntry )

Asks the given enumeration node whether it has an entry with the given symbolic value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	symbolicValue	The symbolic value.
[in]	symbolicValueSize	The size of the symbolic value.
[out]	hasEntry	The returned bool

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolic value and/or hasEntry are/is a null pointer.

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_EnumerationNode_GetHasEntryByValue()

PEAK_C_API PEAK_EnumerationNode_GetHasEntryByValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		int64_t	value,
		PEAK_BOOL8 *	hasEntry )

Asks the given enumeration node whether it has an entry with the given value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	value	The value.
[out]	hasEntry	The returned bool

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolic value and/or hasEntry are/is a null pointer.

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_EnumerationNode_GetNumEntries()

PEAK_C_API PEAK_EnumerationNode_GetNumEntries	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		size_t *	numEntries )

Asks the given enumeration node for its number of entries.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[out]	numEntries	The number of entries.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numEntries is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_SetCurrentEntry()

PEAK_C_API PEAK_EnumerationNode_SetCurrentEntry	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE	enumerationEntryNodeHandle )

Tells the given enumeration node to set its current entry to the given entry.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	enumerationEntryNodeHandle	The entry.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT There is no matching entry in this enumeration node.

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle and/or enumerationEntryNodeHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_SetCurrentEntryBySymbolicValue()

PEAK_C_API PEAK_EnumerationNode_SetCurrentEntryBySymbolicValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		const char *	symbolicValue,
		size_t	symbolicValueSize )

Tells the given enumeration node to set its current entry by the given symbolic value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	symbolicValue	The symbolic value.
[in]	symbolicValueSize	Size of the given buffer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolicValue is a null pointer

PEAK_RETURN_CODE_INVALID_ARGUMENT There is no entry with this symbolicValue in this enumeration node.

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_SetCurrentEntryByValue()

PEAK_C_API PEAK_EnumerationNode_SetCurrentEntryByValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		int64_t	value )

Tells the given enumeration node to set its current entry by the given value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT There is no entry with this value in this enumeration node.

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_ToNode()

PEAK_C_API PEAK_EnumerationNode_ToNode	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given enumeration node to a node.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnumerationNode_TryFindEntryBySymbolicValue()

PEAK_C_API PEAK_EnumerationNode_TryFindEntryBySymbolicValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		const char *	symbolicValue,
		size_t	symbolicValueSize,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Tells the given enumeration node to try to find an entry with the given symbolic value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	symbolicValue	The symbolic value.
[in]	symbolicValueSize	The size of the symbolic value.
[out]	enumerationEntryNodeHandle	The found entry or NULL if not found.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT symbolicValue and/or enumerationEntryNodeHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_EnumerationNode_TryFindEntryByValue()

PEAK_C_API PEAK_EnumerationNode_TryFindEntryByValue	(	PEAK_ENUMERATION_NODE_HANDLE	enumerationNodeHandle,
		int64_t	value,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Tells the given enumeration node to try to find an entry with the given value.

Parameters

[in]	enumerationNodeHandle	The enumeration node.
[in]	value	The value.
[out]	enumerationEntryNodeHandle	The found entry or NULL if not found.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE enumerationNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationEntryNodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_EnvironmentInspector_GetCTIPath()

PEAK_C_API PEAK_EnvironmentInspector_GetCTIPath	(	size_t	index,
		char *	ctiPath,
		size_t *	ctiPathSize )

Asks for the CTI path with the given index.

Parameters

[in]	index	The index to work with.
[out]	ctiPath	The CTI path.
[in,out]	ctiPathSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiPathSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL ctiPathSize is too small

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnvironmentInspector_GetNumCTIPaths()

PEAK_C_API PEAK_EnvironmentInspector_GetNumCTIPaths

(

size_t *

numCtiPaths

)

Asks for the number of CTI paths.

Parameters

[out]

numCtiPaths

The number of CTI paths.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT numCtiPaths is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EnvironmentInspector_UpdateCTIPaths()

PEAK_C_API PEAK_EnvironmentInspector_UpdateCTIPaths

(

)

Collects the paths to the CTIs installed on the system.

This function depends on the architecture the library was compiled for. Therefore, this function collects 64-bit CTIs for a 64-bit library and 32-bit CTIs for a 32-bit library.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_ERROR An internal error has occurred.

PEAK_RETURN_CODE_NOT_FOUND The environment variable GENICAM_GENTL32_PATH / GENICAM_GENTL64_PATH was not found or was empty.

Since

1.0

PEAK_Event_Destruct()

PEAK_C_API PEAK_Event_Destruct

(

PEAK_EVENT_HANDLE

eventHandle

)

Destroys the given event.

Parameters

[in]

eventHandle

The event.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Event_GetData()

PEAK_C_API PEAK_Event_GetData	(	PEAK_EVENT_HANDLE	eventHandle,
		uint8_t *	data,
		size_t *	dataSize )

Asks the given event for its data.

The delivered data depend on the event type.

Parameters

[in]	eventHandle	The event.
[out]	data	The data.
[in,out]	dataSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT dataSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL dataSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Event_GetID()

PEAK_C_API PEAK_Event_GetID	(	PEAK_EVENT_HANDLE	eventHandle,
		uint64_t *	id )

Asks the given event for its ID.

Parameters

[in]	eventHandle	The event.
[out]	id	The ID.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT id is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Event_GetInfo()

PEAK_C_API PEAK_Event_GetInfo	(	PEAK_EVENT_HANDLE	eventHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given event for an information based on a specific command.

Parameters

[in]	eventHandle	The event.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Event_GetRawData()

PEAK_C_API PEAK_Event_GetRawData	(	PEAK_EVENT_HANDLE	eventHandle,
		uint8_t *	rawData,
		size_t *	rawDataSize )

Asks the given event for its raw data.

The delivered data depend on the underlying transport layer (GEV, USB3, ...) and the event type. (e.g. If the underlying CTI implements GEV and the event is a remote device event, the delivered data will be the event raw data of a GEV event)

Parameters

[in]	eventHandle	The event.
[out]	rawData	The raw data.
[in,out]	rawDataSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT rawDataSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL rawDataSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_Event_GetType()

PEAK_C_API PEAK_Event_GetType	(	PEAK_EVENT_HANDLE	eventHandle,
		PEAK_EVENT_TYPE *	type )

Asks the given event for its type.

Parameters

[in]	eventHandle	The event.
[out]	type	The type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT type is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_Destruct()

PEAK_C_API PEAK_EventController_Destruct

(

PEAK_EVENT_CONTROLLER_HANDLE

eventControllerHandle

)

Destroys the given event controller.

Parameters

[in]

eventControllerHandle

The event controller.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_FlushEvents()

PEAK_C_API PEAK_EventController_FlushEvents

(

PEAK_EVENT_CONTROLLER_HANDLE

eventControllerHandle

)

Tells the given event controller to flush all events in queue.

Parameters

[in]

eventControllerHandle

The event controller.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_FlushPendingKillWaits()

PEAK_C_API PEAK_EventController_FlushPendingKillWaits

(

PEAK_EVENT_CONTROLLER_HANDLE

eventControllerHandle

)

Flushes the KillWait queue.

This function clears all queued KillWaits, preventing subsequent calls to PEAK_EventController_WaitForEvent from returning PEAK_RETURN_CODE_ABORTED.

Calls to PEAK_EventController_WaitForEvent that are currently waiting will be aborted and return PEAK_RETURN_CODE_ABORTED.

Parameters

[in]

eventControllerHandle

The handle of the event controller.

Returns

PEAK_RETURN_CODE_SUCCESS If everything was successful.

PEAK_RETURN_CODE_INVALID_HANDLE If the dataStreamHandle is invalid.

PEAK_RETURN_CODE_BAD_ACCESS If the acquisition is running and must be stopped.

PEAK_RETURN_CODE_ERROR If an internal error occurs.

Since

1.11

PEAK_EventController_GetControlledEventType()

PEAK_C_API PEAK_EventController_GetControlledEventType	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		PEAK_EVENT_TYPE *	controlledEventType )

Asks the event controller for its controlled event type.

Parameters

[in]	eventControllerHandle	The event controller.
[out]	controlledEventType	The controlled event type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT controlledEventType is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_GetEventDataMaxSize()

PEAK_C_API PEAK_EventController_GetEventDataMaxSize	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		size_t *	eventDataMaxSize )

Asks the event controller for the maximum size of an event's data.

Parameters

[in]	eventControllerHandle	The event controller.
[out]	eventDataMaxSize	The maximum size of an event's data.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventDataMaxSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_GetEventMaxSize()

PEAK_C_API PEAK_EventController_GetEventMaxSize	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		size_t *	eventMaxSize )

Asks the event controller for the maximum size of an event.

Parameters

[in]	eventControllerHandle	The event controller.
[out]	eventMaxSize	The maximum size of an event.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventMaxSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_GetInfo()

PEAK_C_API PEAK_EventController_GetInfo	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given event controller for an information based on a specific command.

Parameters

[in]	eventControllerHandle	The event controller.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_GetNumEventsFired()

PEAK_C_API PEAK_EventController_GetNumEventsFired	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		uint64_t *	numEventsFired )

Asks the event controller for its number of fired events.

Parameters

[in]	eventControllerHandle	The event controller.
[out]	numEventsFired	The number of fired events.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numEventsFired is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_GetNumEventsInQueue()

PEAK_C_API PEAK_EventController_GetNumEventsInQueue	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		size_t *	numEventsInQueue )

Asks the event controller for its number of events in queue.

Parameters

[in]	eventControllerHandle	The event controller.
[out]	numEventsInQueue	The number of events in queue.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numEventsInQueue is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_KillWait()

PEAK_C_API PEAK_EventController_KillWait

(

PEAK_EVENT_CONTROLLER_HANDLE

eventControllerHandle

)

Cancels a pending PEAK_EventController_WaitForEvent call.

Calling PEAK_EventController_KillWait will interrupt an ongoing PEAK_EventController_WaitForEvent call, causing it to return PEAK_RETURN_CODE_ABORTED.

If no PEAK_EventController_WaitForEvent call is currently active, the cancellation request will be queued. The next call to PEAK_EventController_WaitForEvent will then be aborted. Multiple invocations of PEAK_EventController_KillWait will add multiple cancellation requests to the queue.

Note

To clear the queued cancellations, you can re-register the event by reconstructing the EventController using PEAK_EventController_Destruct and PEAK_EventSupportingModule_EnableEvents.

Parameters

[in]

eventControllerHandle

The event controller.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventController_WaitForEvent()

PEAK_C_API PEAK_EventController_WaitForEvent	(	PEAK_EVENT_CONTROLLER_HANDLE	eventControllerHandle,
		uint64_t	timeout_ms,
		PEAK_EVENT_HANDLE *	eventHandle )

Tells the given event controller to wait for an event with the given timeout.

Parameters

[in]	eventControllerHandle	The event controller.
[in]	timeout_ms	The timeout.
[out]	eventHandle	The event.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_ABORTED The wait has been aborted.

PEAK_RETURN_CODE_TIMEOUT The wait timed out

PEAK_RETURN_CODE_INVALID_ARGUMENT eventHandle is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE eventControllerHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_EventSupportingModule_EnableEvents()

PEAK_C_API PEAK_EventSupportingModule_EnableEvents	(	PEAK_EVENT_SUPPORTING_MODULE_HANDLE	eventSupportingModuleHandle,
		PEAK_EVENT_TYPE	eventType,
		PEAK_EVENT_CONTROLLER_HANDLE *	eventControllerHandle )

Tells the given event-supporting module to enable events of the given type.

Parameters

[in]	eventSupportingModuleHandle	The event-supporting module.
[in]	eventType	The event type to enable.
[out]	eventControllerHandle	The event controller being associated with the given event type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE eventSupportingModuleHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventControllerHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FileAdapter_Construct()

PEAK_C_API PEAK_FileAdapter_Construct	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	fileName,
		PEAK_FILE_ADAPTER_HANDLE *	fileAdapterHandle )

Creates a file adapter.

Parameters

[in]	nodeMapHandle	The node map.
[in]	fileName	The name of the selected camera file to open.
[out]	fileAdapterHandle	The file adapter.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileName or fileAdapterHandle is a null pointer

PEAK_RETURN_CODE_NOT_AVAILABLE 'FileSelector' node, or it's entry with the specified fileName is not available

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FileAdapter_Delete()

PEAK_C_API PEAK_FileAdapter_Delete

(

PEAK_FILE_ADAPTER_HANDLE

fileAdapterHandle

)

Deletes the given file.

Parameters

[in]

fileAdapterHandle

The file adapter.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred or file cannot be removed.

Since

1.10

PEAK_FileAdapter_Destruct()

PEAK_C_API PEAK_FileAdapter_Destruct

(

PEAK_FILE_ADAPTER_HANDLE

fileAdapterHandle

)

Destroys the given file adapter.

Parameters

[in]

fileAdapterHandle

The file adapter.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FileAdapter_GetMaxSize()

PEAK_C_API PEAK_FileAdapter_GetMaxSize	(	PEAK_FILE_ADAPTER_HANDLE	fileAdapterHandle,
		uint64_t *	maxSize )

Queries the maximum size of the given file.

Parameters

[in]	fileAdapterHandle	The file adapter.
[out]	maxSize	The maximum size of the file.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FileAdapter_GetSize()

PEAK_C_API PEAK_FileAdapter_GetSize	(	PEAK_FILE_ADAPTER_HANDLE	fileAdapterHandle,
		uint64_t *	size )

Queries the size of the given file.

Parameters

[in]	fileAdapterHandle	The file adapter.
[out]	size	The size of the file.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FileAdapter_Read()

PEAK_C_API PEAK_FileAdapter_Read	(	PEAK_FILE_ADAPTER_HANDLE	fileAdapterHandle,
		uint64_t	size,
		uint64_t	offset,
		uint8_t *	data,
		uint64_t *	dataSize )

Reads from the given file.

Parameters

[in]	fileAdapterHandle	The file adapter.
[in]	size	The amount of data to be read.
[in]	offset	The position from the beginning of the file where data reading should start.
[out]	data	The file content.
[out]	dataSize	The actual amount of data read.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_OUT_OF_RANGE size + offset exceeds the specified file's size

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FileAdapter_Write()

PEAK_C_API PEAK_FileAdapter_Write	(	PEAK_FILE_ADAPTER_HANDLE	fileAdapterHandle,
		const uint8_t *	data,
		uint64_t	size,
		uint64_t	offset )

Writes to the given file.

Parameters

[in]	fileAdapterHandle	The file adapter.
[in]	data	The data to be written.
[in]	size	The size to be written.
[in]	offset	Defines where to write the data.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE fileAdapter is invalid

PEAK_RETURN_CODE_OUT_OF_RANGE size + offset exceeds the specified file's size or offset cannot be set

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_FirmwareUpdateInformation_GetDescription()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetDescription	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	description,
		size_t *	descriptionSize )

Asks the given firmware update information for its description.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	description	The description.
[in,out]	descriptionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT descriptionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL descriptionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetFileName()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetFileName	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	fileName,
		size_t *	fileNameSize )

Asks the given firmware update information for its file name.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	fileName	The file name.
[in,out]	fileNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL fileNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetIsValid()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetIsValid	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_BOOL8 *	isValid )

Asks the given firmware update information whether it is valid.

Parameters

[in]	firmwareUpdateInformationHandle	The firmware update information.
[out]	isValid	A flag telling whether the firmware update information is valid.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isValid is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetReleaseNotes()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetReleaseNotes	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	releaseNotes,
		size_t *	releaseNotesSize )

Asks the given firmware update information for its release notes.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	releaseNotes	The release notes.
[in,out]	releaseNotesSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT releaseNotesSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL releaseNotesSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetReleaseNotesURL()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetReleaseNotesURL	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	releaseNotesUrl,
		size_t *	releaseNotesUrlSize )

Asks the given firmware update information for its release notes URL.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	releaseNotesUrl	The release notes URL.
[in,out]	releaseNotesUrlSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT releaseNotesUrlSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL releaseNotesUrlSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetSequencerSetPersistence()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetSequencerSetPersistence	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_FIRMWARE_UPDATE_PERSISTENCE *	sequencerSetPersistence )

Asks the given firmware update information for its sequencer set persistence.

Parameters

[in]	firmwareUpdateInformationHandle	The firmware update information.
[out]	sequencerSetPersistence	The sequencer set persistence.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT sequencerSetPersistence is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetUserSetPersistence()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetUserSetPersistence	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_FIRMWARE_UPDATE_PERSISTENCE *	userSetPersistence )

Asks the given firmware update information for its user set persistence.

Parameters

[in]	firmwareUpdateInformationHandle	The firmware update information.
[out]	userSetPersistence	The user set persistence.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT userSetPersistence is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetVersion()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersion	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	version,
		size_t *	versionSize )

Asks the given firmware update information for its version.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetVersionExtractionPattern()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersionExtractionPattern	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		char *	versionExtractionPattern,
		size_t *	versionExtractionPatternSize )

Asks the given firmware update information for its version extraction pattern.

Parameters

[in]	firmwareUpdateInformationHandle	The port.
[out]	versionExtractionPattern	The version extraction pattern.
[in,out]	versionExtractionPatternSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionExtractionPatternSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionExtractionPatternSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateInformation_GetVersionStyle()

PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersionStyle	(	PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_FIRMWARE_UPDATE_VERSION_STYLE *	versionStyle )

Asks the given firmware update information for its version style.

Parameters

[in]	firmwareUpdateInformationHandle	The firmware update information.
[out]	versionStyle	The version style.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateInformationHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionStyle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_Construct()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_Construct

(

PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE *

firmwareUpdateProgressObserverHandle

)

Creates a firmware update progress observer.

Parameters

[out]

firmwareUpdateProgressObserverHandle

The firmware update progress observer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT firmwareUpdateProgressObserverHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_Destruct()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_Destruct

(

PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE

firmwareUpdateProgressObserverHandle

)

Destroys the given firmware update progress observer.

Parameters

[in]

firmwareUpdateProgressObserverHandle

The firmware update progress observer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFailedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFailedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a failed update at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFinishedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFinishedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a finished update at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStartedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStartedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a started update at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepFinishedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepFinishedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a finished update step at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepProgressChangedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepProgressChangedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a progress change within an update step at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepStartedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepStartedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a started update step at the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFailedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFailedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update failed callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFinishedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFinishedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update finished callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStartedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStartedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update started callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepFinishedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepFinishedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update step finished callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepProgressChangedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepProgressChangedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update step progress changed callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepStartedCallback()

PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepStartedCallback	(	PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE	callbackHandle )

Unregisters the update step started callback with the given handle from the given firmware update progress observer.

Parameters

[in]	firmwareUpdateProgressObserverHandle	The firmware update progress observer.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdateProgressObserverHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_CollectAllFirmwareUpdateInformation()

PEAK_C_API PEAK_FirmwareUpdater_CollectAllFirmwareUpdateInformation	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		const char *	gufPath,
		size_t	gufPathSize )

Tells the given firmware updater to collect all update information from the .guf file.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[in]	gufPath	The path to the *.guf file.
[in]	gufPathSize	The size of the given *.guf file path.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle and/or deviceDescriptorHandle are/is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT gufPath is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_FirmwareUpdater_CollectFirmwareUpdateInformation()

PEAK_C_API PEAK_FirmwareUpdater_CollectFirmwareUpdateInformation	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		const char *	gufPath,
		size_t	gufPathSize,
		PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle )

Tells the given firmware updater to collect all update information fitting to the given device.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[in]	gufPath	The path to the *.guf file.
[in]	gufPathSize	The size of the given *.guf file path.
[in]	deviceDescriptorHandle	The device the update information have to fit to.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT gufPath is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle and/or deviceDescriptorHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_Construct()

PEAK_C_API PEAK_FirmwareUpdater_Construct

(

PEAK_FIRMWARE_UPDATER_HANDLE *

firmwareUpdaterHandle

)

Creates a firmware updater.

Parameters

[out]

firmwareUpdaterHandle

The firmware updater.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT firmwareUpdaterHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_Destruct()

PEAK_C_API PEAK_FirmwareUpdater_Destruct

(

PEAK_FIRMWARE_UPDATER_HANDLE

firmwareUpdaterHandle

)

Destroys the given firmware updater.

Parameters

[in]

firmwareUpdaterHandle

The firmware updater.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_GetFirmwareUpdateInformation()

PEAK_C_API PEAK_FirmwareUpdater_GetFirmwareUpdateInformation	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		size_t	index,
		PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE *	firmwareUpdateInformationHandle )

Asks the given firmware updater for the update information with the given index.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[in]	index	The index.
[out]	firmwareUpdateInformationHandle	The update information being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT firmwareUpdateInformationHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_GetNumFirmwareUpdateInformation()

PEAK_C_API PEAK_FirmwareUpdater_GetNumFirmwareUpdateInformation	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		size_t *	numFirmwareUpdateInformation )

Asks the given firmware updater for its number of update information.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[out]	numFirmwareUpdateInformation	The number of update information.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numFirmwareUpdateInformation is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_UpdateDevice()

PEAK_C_API PEAK_FirmwareUpdater_UpdateDevice	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle )

Tells the given firmware updater to update the given device with the given update information.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[in]	deviceDescriptorHandle	The device.
[in]	firmwareUpdateInformationHandle	The update information.
[in]	firmwareUpdateProgressObserverHandle	Used to observe the update process. Can be a null pointer.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_TIMEOUT The device can't be found after a reboot within 60 seconds.

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle and/or deviceDescriptorHandle and/or firmwareUpdateInformationHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FirmwareUpdater_UpdateDeviceWithResetTimeout()

PEAK_C_API PEAK_FirmwareUpdater_UpdateDeviceWithResetTimeout	(	PEAK_FIRMWARE_UPDATER_HANDLE	firmwareUpdaterHandle,
		PEAK_DEVICE_DESCRIPTOR_HANDLE	deviceDescriptorHandle,
		PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE	firmwareUpdateInformationHandle,
		PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE	firmwareUpdateProgressObserverHandle,
		uint64_t	deviceResetDiscoveryTimeout_ms )

Tells the given firmware updater to update the given device with the given update information.

Parameters

[in]	firmwareUpdaterHandle	The firmware updater.
[in]	deviceDescriptorHandle	The device.
[in]	firmwareUpdateInformationHandle	The update information.
[in]	firmwareUpdateProgressObserverHandle	Used to observe the update process. Can be a null pointer.
[in]	deviceResetDiscoveryTimeout_ms	Time to wait for a device to reboot during the update.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_TIMEOUT The device can't be found after a reboot within the deviceResetDiscoveryTimeout.

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE firmwareUpdaterHandle and/or deviceDescriptorHandle and/or firmwareUpdateInformationHandle are/is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_FloatNode_GetDisplayNotation()

PEAK_C_API PEAK_FloatNode_GetDisplayNotation	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_NODE_DISPLAY_NOTATION *	displayNotation )

Asks the given float node for its display notation.

Parameters

[in]	floatNodeHandle	The float node.
[out]	displayNotation	The display notation.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNotation is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetDisplayPrecision()

PEAK_C_API PEAK_FloatNode_GetDisplayPrecision	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		int64_t *	displayPrecision )

Asks the given float node for its display precision.

Parameters

[in]	floatNodeHandle	The float node.
[out]	displayPrecision	The display precision.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayPrecision is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetHasConstantIncrement()

PEAK_C_API PEAK_FloatNode_GetHasConstantIncrement	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_BOOL8 *	hasConstantIncrement )

Asks the given float node whether it has a constant increment.

Parameters

[in]	floatNodeHandle	The float node.
[out]	hasConstantIncrement	A flag telling whether the float node has a constant increment.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasConstantIncrement is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetIncrement()

PEAK_C_API PEAK_FloatNode_GetIncrement	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		double *	increment )

Asks the given float node for its increment.

Parameters

[in]	floatNodeHandle	The float node.
[out]	increment	The increment.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT increment is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetIncrementType()

PEAK_C_API PEAK_FloatNode_GetIncrementType	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_NODE_INCREMENT_TYPE *	incrementType )

Asks the given float node for its increment type.

Parameters

[in]	floatNodeHandle	The float node.
[out]	incrementType	The increment type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT incrementType is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetMaximum()

PEAK_C_API PEAK_FloatNode_GetMaximum	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		double *	maximum )

Asks the given float node for its maximum.

Parameters

[in]	floatNodeHandle	The float node.
[out]	maximum	The maximum.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT maximum is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetMinimum()

PEAK_C_API PEAK_FloatNode_GetMinimum	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		double *	minimum )

Asks the given float node for its minimum.

Parameters

[in]	floatNodeHandle	The float node.
[out]	minimum	The minimum.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT minimum is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetRepresentation()

PEAK_C_API PEAK_FloatNode_GetRepresentation	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_NODE_REPRESENTATION *	representation )

Asks the given float node for its representation.

Parameters

[in]	floatNodeHandle	The float node.
[out]	representation	The representation.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT representation is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetUnit()

PEAK_C_API PEAK_FloatNode_GetUnit	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		char *	unit,
		size_t *	unitSize )

Asks the given float node for its unit.

Parameters

[in]	floatNodeHandle	The float node.
[out]	unit	The unit.
[in,out]	unitSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT unitSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetValidValues()

PEAK_C_API PEAK_FloatNode_GetValidValues	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		double *	validValues,
		size_t *	validValuesSize )

Asks the given float node for its valid values.

Parameters

[in]	floatNodeHandle	The float node.
[out]	validValues	The valid values.
[in,out]	validValuesSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT validValuesSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL validValuesSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_GetValue()

PEAK_C_API PEAK_FloatNode_GetValue	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		double *	value )

Asks the given float node for its value.

Parameters

[in]	floatNodeHandle	The float node.
[in]	cacheUsePolicy	The cache use policy.
[out]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT value is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_SetValue()

PEAK_C_API PEAK_FloatNode_SetValue	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		double	value )

Tells the given float node to set the given value.

Parameters

[in]	floatNodeHandle	The float node.
[in]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_FloatNode_ToNode()

PEAK_C_API PEAK_FloatNode_ToNode	(	PEAK_FLOAT_NODE_HANDLE	floatNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given float node to a node.

Parameters

[in]	floatNodeHandle	The float node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE floatNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetIncrement()

PEAK_C_API PEAK_IntegerNode_GetIncrement	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		int64_t *	increment )

Asks the given integer node for its increment.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	increment	The increment.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT increment is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetIncrementType()

PEAK_C_API PEAK_IntegerNode_GetIncrementType	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		PEAK_NODE_INCREMENT_TYPE *	incrementType )

Asks the given integer node for its increment type.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	incrementType	The increment type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT incrementType is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetMaximum()

PEAK_C_API PEAK_IntegerNode_GetMaximum	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		int64_t *	maximum )

Asks the given integer node for its maximum.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	maximum	The maximum.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT maximum is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetMinimum()

PEAK_C_API PEAK_IntegerNode_GetMinimum	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		int64_t *	minimum )

Asks the given integer node for its minimum.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	minimum	The minimum.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT minimum is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetRepresentation()

PEAK_C_API PEAK_IntegerNode_GetRepresentation	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		PEAK_NODE_REPRESENTATION *	representation )

Asks the given integer node for its representation.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	representation	The representation.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT representation is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetUnit()

PEAK_C_API PEAK_IntegerNode_GetUnit	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		char *	unit,
		size_t *	unitSize )

Asks the given integer node for its unit.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	unit	The unit.
[in,out]	unitSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT unitSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetValidValues()

PEAK_C_API PEAK_IntegerNode_GetValidValues	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		int64_t *	validValues,
		size_t *	validValuesSize )

Asks the given integer node for its valid values.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	validValues	The valid values.
[in,out]	validValuesSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT validValuesSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL validValuesSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_GetValue()

PEAK_C_API PEAK_IntegerNode_GetValue	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		int64_t *	value )

Asks the given integer node for its value.

Parameters

[in]	integerNodeHandle	The integer node.
[in]	cacheUsePolicy	The cache use policy.
[out]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT value is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_SetValue()

PEAK_C_API PEAK_IntegerNode_SetValue	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		int64_t	value )

Tells the given integer node to set the given value.

Parameters

[in]	integerNodeHandle	The integer node.
[in]	value	The value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_IntegerNode_ToNode()

PEAK_C_API PEAK_IntegerNode_ToNode	(	PEAK_INTEGER_NODE_HANDLE	integerNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given integer node to a node.

Parameters

[in]	integerNodeHandle	The integer node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE integerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_Destruct()

PEAK_C_API PEAK_Interface_Destruct

(

PEAK_INTERFACE_HANDLE

interfaceHandle

)

Destroys the given interface.

Parameters

[in]

interfaceHandle

The interface.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetDevice()

PEAK_C_API PEAK_Interface_GetDevice	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		size_t	index,
		PEAK_DEVICE_DESCRIPTOR_HANDLE *	deviceDescriptorHandle )

Asks the given interface for the device descriptor with the given index.

Parameters

[in]	interfaceHandle	The interface.
[in]	index	The index.
[out]	deviceDescriptorHandle	The device descriptor being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deviceDescriptorHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetDisplayName()

PEAK_C_API PEAK_Interface_GetDisplayName	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given interface for its display name.

Parameters

[in]	interfaceHandle	The interface.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetID()

PEAK_C_API PEAK_Interface_GetID	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		char *	id,
		size_t *	idSize )

Asks the given interface for its ID.

Parameters

[in]	interfaceHandle	The interface.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetInfo()

PEAK_C_API PEAK_Interface_GetInfo	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given interface for an information based on a specific command.

Parameters

[in]	interfaceHandle	The interface.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetKey()

PEAK_C_API PEAK_Interface_GetKey	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		char *	key,
		size_t *	keySize )

Asks the given interface for its key.

Parameters

[in]	interfaceHandle	The interface.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetNumDevices()

PEAK_C_API PEAK_Interface_GetNumDevices	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		size_t *	numDevices )

Asks the given interface for its number of devices.

Parameters

[in]	interfaceHandle	The interface.
[out]	numDevices	The number of devices.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numDevices is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetParentSystem()

PEAK_C_API PEAK_Interface_GetParentSystem	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_SYSTEM_HANDLE *	systemHandle )

Asks the given interface for its parent system.

Parameters

[in]	interfaceHandle	The interface.
[out]	systemHandle	The parent system.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT systemHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_GetTLType()

PEAK_C_API PEAK_Interface_GetTLType	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given interface for its TL type.

Parameters

[in]	interfaceHandle	The interface.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_RegisterDeviceDisconnectedCallback()

PEAK_C_API PEAK_Interface_RegisterDeviceDisconnectedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_DISCONNETED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a disconnected device that is now waiting to be reconnected at the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_RegisterDeviceFoundCallback()

PEAK_C_API PEAK_Interface_RegisterDeviceFoundCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_FOUND_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_FOUND_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a found device at the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_RegisterDeviceListChangedCallback()

PEAK_C_API PEAK_Interface_RegisterDeviceListChangedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_LIST_CHANGED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a change in the device list at the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_RegisterDeviceLostCallback()

PEAK_C_API PEAK_Interface_RegisterDeviceLostCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_LOST_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_LOST_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a lost device at the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_RegisterDeviceReconnectedCallback()

PEAK_C_API PEAK_Interface_RegisterDeviceReconnectedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_RECONNECTED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a reconnected device at the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_AVAILABLE reconnect callback is not available

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_ToEventSupportingModule()

PEAK_C_API PEAK_Interface_ToEventSupportingModule	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_EVENT_SUPPORTING_MODULE_HANDLE *	eventSupportingModuleHandle )

Casts the given interface to an event-supporting module.

Parameters

[in]	interfaceHandle	The interface.
[out]	eventSupportingModuleHandle	The event-supporting module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventSupportingModuleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_ToModule()

PEAK_C_API PEAK_Interface_ToModule	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given interface to a module.

Parameters

[in]	interfaceHandle	The interface.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_UnregisterDeviceDisconnectedCallback()

PEAK_C_API PEAK_Interface_UnregisterDeviceDisconnectedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE	callbackHandle )

Unregisters the device disconnected callback with the given handle from the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_UnregisterDeviceFoundCallback()

PEAK_C_API PEAK_Interface_UnregisterDeviceFoundCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_FOUND_CALLBACK_HANDLE	callbackHandle )

Unregisters the device-found callback with the given handle from the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_UnregisterDeviceListChangedCallback()

PEAK_C_API PEAK_Interface_UnregisterDeviceListChangedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE	callbackHandle )

Unregisters the device-list-changed callback with the given handle from the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_UnregisterDeviceLostCallback()

PEAK_C_API PEAK_Interface_UnregisterDeviceLostCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_LOST_CALLBACK_HANDLE	callbackHandle )

Unregisters the device-lost callback with the given handle from the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Interface_UnregisterDeviceReconnectedCallback()

PEAK_C_API PEAK_Interface_UnregisterDeviceReconnectedCallback	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE	callbackHandle )

Unregisters the device-reconnected callback with the given handle from the given interface.

Parameters

[in]	interfaceHandle	The interface.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.7

PEAK_Interface_UpdateDevices()

PEAK_C_API PEAK_Interface_UpdateDevices	(	PEAK_INTERFACE_HANDLE	interfaceHandle,
		uint64_t	timeout_ms )

Tells the given interface to update its devices with the given timeout.

Parameters

[in]	interfaceHandle	The interface.
[in]	timeout_ms	The time to wait for discovery.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_GetDisplayName()

PEAK_C_API PEAK_InterfaceDescriptor_GetDisplayName	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given interface descriptor for its display name.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_GetInfo()

PEAK_C_API PEAK_InterfaceDescriptor_GetInfo	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given interface descriptor for an information based on a specific command.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_GetKey()

PEAK_C_API PEAK_InterfaceDescriptor_GetKey	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		char *	key,
		size_t *	keySize )

Asks the given interface descriptor for its key.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_GetParentSystem()

PEAK_C_API PEAK_InterfaceDescriptor_GetParentSystem	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		PEAK_SYSTEM_HANDLE *	systemHandle )

Asks the given interface descriptor for its parent system.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	systemHandle	The parent system.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT systemHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_GetTLType()

PEAK_C_API PEAK_InterfaceDescriptor_GetTLType	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given interface descriptor for its TL type.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_OpenInterface()

PEAK_C_API PEAK_InterfaceDescriptor_OpenInterface	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		PEAK_INTERFACE_HANDLE *	interfaceHandle )

Opens the interface being associated with the given interface descriptor.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	interfaceHandle	The interface.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT interfaceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_InterfaceDescriptor_ToModuleDescriptor()

PEAK_C_API PEAK_InterfaceDescriptor_ToModuleDescriptor	(	PEAK_INTERFACE_DESCRIPTOR_HANDLE	interfaceDescriptorHandle,
		PEAK_MODULE_DESCRIPTOR_HANDLE *	moduleDescriptorHandle )

Casts the given interface descriptor to a module descriptor.

Parameters

[in]	interfaceDescriptorHandle	The interface descriptor.
[out]	moduleDescriptorHandle	The module descriptor.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE interfaceDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleDescriptorHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Library_Close()

PEAK_C_API PEAK_Library_Close

(

)

Closes the IDS peak genericAPI library and cleans up any resources that are still in use.

This function should be called after no function of the library is needed anymore, before unloading the library. It cleans up any resources still in use.

Note

Calling any other function (except PEAK_Library_Initialize()) after this will return a PEAK_RETURN_CODE_NOT_INITIALIZED error.

Warning

It is of particular importance on MS Windows platforms when using "Run-Time Dynamic Linking", especially when unloading the DLL with FreeLibrary(). Otherwise it is very likely to run into the "Loader-Lock Deadlock Problem" during DLL unloading.

PEAK_Library_GetLastError()

PEAK_C_API PEAK_Library_GetLastError	(	PEAK_RETURN_CODE *	lastErrorCode,
		char *	lastErrorDescription,
		size_t *	lastErrorDescriptionSize )

Queries the last error.

This function is normally used by applying a two-step procedure. First of all, you call the function with all arguments except of lastErrorDescription.

// Error handling is omitted
PEAK_RETURN_CODE lastErrorCode = PEAK_RETURN_CODE_SUCCESS;
size_t size = 0;
PEAK_Library_GetLastError(&lastErrorCode, NULL, &size);

The function then gives you the last error code and the size of the error description. You could stop now if you only want to query the last error code. If you want to query the error description as well, you have to go on.

// Error handling is omitted
char errorDescription[size];
PEAK_Library_GetLastError(&returnCode, errorDescription, &size);

This two-step procedure may not be necessary if you just pass a buffer big enough for holding the description at the first function call.

Parameters

[out]	lastErrorCode	The last function error code.
[out]	lastErrorDescription	The description for the last error.
[in,out]	lastErrorDescriptionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT lastErrorCode and/or lastErrorCodeDescriptionSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL lastErrorDescriptionSize is too small

Since

1.0

PEAK_Library_GetVersionMajor()

PEAK_C_API PEAK_Library_GetVersionMajor

(

uint32_t *

libraryVersionMajor

)

Asks for the major component of the library version.

Parameters

[out]

libraryVersionMajor

The major component of the library version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT libraryVersionMajor is a null pointer

Since

1.0

PEAK_Library_GetVersionMinor()

PEAK_C_API PEAK_Library_GetVersionMinor

(

uint32_t *

libraryVersionMinor

)

Asks for the minor component of the library version.

Parameters

[out]

libraryVersionMinor

The minor component of the library version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT libraryVersionMinor is a null pointer

Since

1.0

PEAK_Library_GetVersionSubminor()

PEAK_C_API PEAK_Library_GetVersionSubminor

(

uint32_t *

libraryVersionSubminor

)

Asks for the subminor component of the library version.

Parameters

[out]

libraryVersionSubminor

The subminor component of the library version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT libraryVersionSubminor is a null pointer

Since

1.0

PEAK_Library_Initialize()

PEAK_C_API PEAK_Library_Initialize

(

)

Initializes the IDS peak genericAPI library.

This function must be called prior to any other function call to allow global initialization of library internals. This function is necessary since automated initialization functionality like within DllMain on MS Windows platforms is very limited.

Calling this function multiple times is ok, but note that there is no reference counting, so the first call to PEAK_Library_Close() will close the library.

Note

Calling any other function before this will return a PEAK_RETURN_CODE_NOT_INITIALIZED error.

PEAK_Library_IsInitialized()

PEAK_C_API PEAK_Library_IsInitialized

(

PEAK_BOOL8 *

isInitialized

)

Checks if the IDS peak genericAPI library is initialized.

Parameters

[out]

isInitialized

Flag telling whether the IDS peak genericAPI library is initialized.

Returns

PEAK_RETURN_CODE_INVALID_ARGUMENT isInitialized is a null pointer

Since

1.0

PEAK_Module_GetNodeMap()

PEAK_C_API PEAK_Module_GetNodeMap	(	PEAK_MODULE_HANDLE	moduleHandle,
		size_t	index,
		PEAK_NODE_MAP_HANDLE *	nodeMapHandle )

Asks the given module for the node map with the given index.

Parameters

[in]	moduleHandle	The module.
[in]	index	The index.
[out]	nodeMapHandle	The node map being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE moduleHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeMapHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Module_GetNumNodeMaps()

PEAK_C_API PEAK_Module_GetNumNodeMaps	(	PEAK_MODULE_HANDLE	moduleHandle,
		size_t *	numNodeMaps )

Asks the given module for its number of node maps.

Parameters

[in]	moduleHandle	The module.
[out]	numNodeMaps	The number of node maps.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE moduleHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numNodeMaps is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Module_GetPort()

PEAK_C_API PEAK_Module_GetPort	(	PEAK_MODULE_HANDLE	moduleHandle,
		PEAK_PORT_HANDLE *	portHandle )

Asks the given module for its port.

Parameters

[in]	moduleHandle	The module.
[out]	portHandle	The port.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE moduleHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT portHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_ModuleDescriptor_GetID()

PEAK_C_API PEAK_ModuleDescriptor_GetID	(	PEAK_MODULE_DESCRIPTOR_HANDLE	moduleDescriptorHandle,
		char *	id,
		size_t *	idSize )

Asks the given module descriptor for its ID.

Parameters

[in]	moduleDescriptorHandle	The module descriptor.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_FindInvalidatedNode()

PEAK_C_API PEAK_Node_FindInvalidatedNode	(	PEAK_NODE_HANDLE	nodeHandle,
		const char *	name,
		size_t	nameSize,
		PEAK_NODE_HANDLE *	invalidatedNodeHandle )

Tells the given node to find an invalidated node with the given name.

Parameters

[in]	nodeHandle	The node.
[in]	name	The name of the node to find.
[in]	nameSize	The size of the name.
[out]	invalidatedNodeHandle	The found node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT name and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no invalidated node with the given name

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_FindInvalidatingNode()

PEAK_C_API PEAK_Node_FindInvalidatingNode	(	PEAK_NODE_HANDLE	nodeHandle,
		const char *	name,
		size_t	nameSize,
		PEAK_NODE_HANDLE *	invalidatingNodeHandle )

Tells the given node to find an invalidating node with the given name.

Parameters

[in]	nodeHandle	The node.
[in]	name	The name of the node to find.
[in]	nameSize	The size of the name.
[out]	invalidatingNodeHandle	The found node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT name and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no invalidating node with the given name

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_FindSelectedNode()

PEAK_C_API PEAK_Node_FindSelectedNode	(	PEAK_NODE_HANDLE	nodeHandle,
		const char *	name,
		size_t	nameSize,
		PEAK_NODE_HANDLE *	selectedNodeHandle )

Tells the given node to find a selected node with the given name.

Parameters

[in]	nodeHandle	The node.
[in]	name	The name of the node to find.
[in]	nameSize	The size of the name.
[out]	selectedNodeHandle	The found node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT name and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no selected node with the given name

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_FindSelectingNode()

PEAK_C_API PEAK_Node_FindSelectingNode	(	PEAK_NODE_HANDLE	nodeHandle,
		const char *	name,
		size_t	nameSize,
		PEAK_NODE_HANDLE *	selectingNodeHandle )

Tells the given node to find a selecting node with the given name.

Parameters

[in]	nodeHandle	The node.
[in]	name	The name of the node to find.
[in]	nameSize	The size of the name.
[out]	selectingNodeHandle	The found node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT name and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no selecting node with the given name

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetAccessStatus()

PEAK_C_API PEAK_Node_GetAccessStatus	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_ACCESS_STATUS *	accessStatus )

Asks the given node for its access status.

Parameters

[in]	nodeHandle	The node.
[out]	accessStatus	The access status.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device is disconnected.

PEAK_RETURN_CODE_INVALID_ARGUMENT accessStatus is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetCachingMode()

PEAK_C_API PEAK_Node_GetCachingMode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_CACHING_MODE *	cachingMode )

Asks the given node for its caching mode.

Parameters

[in]	nodeHandle	The node.
[out]	cachingMode	The caching mode.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT cachingMode is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetDescription()

PEAK_C_API PEAK_Node_GetDescription	(	PEAK_NODE_HANDLE	nodeHandle,
		char *	description,
		size_t *	descriptionSize )

Asks the given node for its description.

Parameters

[in]	nodeHandle	The node.
[out]	description	The description.
[in,out]	descriptionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT descriptionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL descriptionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetDisplayName()

PEAK_C_API PEAK_Node_GetDisplayName	(	PEAK_NODE_HANDLE	nodeHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given node for its display name.

Parameters

[in]	nodeHandle	The node.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetInvalidatedNode()

PEAK_C_API PEAK_Node_GetInvalidatedNode	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	invalidatedNodeHandle )

Asks the given node for the invalidated node with the given index.

Parameters

[in]	nodeHandle	The node.
[in]	index	The index.
[out]	invalidatedNodeHandle	The invalidated node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT invalidatedNodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetInvalidatingNode()

PEAK_C_API PEAK_Node_GetInvalidatingNode	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	invalidatingNodeHandle )

Asks the given node for the invalidating node with the given index.

Parameters

[in]	nodeHandle	The node.
[in]	index	The index.
[out]	invalidatingNodeHandle	The invalidating node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT invalidatingNodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetIsAccessStatusCacheable()

PEAK_C_API PEAK_Node_GetIsAccessStatusCacheable	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOL8 *	isAccessStatusCacheable )

Asks the given node whether its access status is cacheable.

Parameters

[in]	nodeHandle	The node.
[out]	isAccessStatusCacheable	A flag telling whether the node's access status is cacheable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isAccessStatusCacheable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetIsCacheable()

PEAK_C_API PEAK_Node_GetIsCacheable	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOL8 *	isCacheable )

Asks the given node whether it is cacheable.

Parameters

[in]	nodeHandle	The node.
[out]	isCacheable	A flag telling whether the node is cacheable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isCacheable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetIsDeprecated()

PEAK_C_API PEAK_Node_GetIsDeprecated	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOL8 *	isDeprecated )

Asks the given node whether it is deprecated.

Parameters

[in]	nodeHandle	The node.
[out]	isDeprecated	A flag telling whether the node is deprecated.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isDeprecated is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetIsFeature()

PEAK_C_API PEAK_Node_GetIsFeature	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOL8 *	isFeature )

Asks the given node whether it is a feature, i.e. it can be reached via category nodes from a category node named "Root".

Parameters

[in]	nodeHandle	The node.
[out]	isFeature	A flag telling whether the node is a feature.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isFeature is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_Node_GetIsStreamable()

PEAK_C_API PEAK_Node_GetIsStreamable	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOL8 *	isStreamable )

Asks the given node whether it is streamable.

Parameters

[in]	nodeHandle	The node.
[out]	isStreamable	A flag telling whether the node is streamable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isStreamable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetName()

PEAK_C_API PEAK_Node_GetName	(	PEAK_NODE_HANDLE	nodeHandle,
		char *	name,
		size_t *	nameSize )

Asks the given node for its name.

Parameters

[in]	nodeHandle	The node.
[out]	name	The name.
[in,out]	nameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL nameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetNamespace()

PEAK_C_API PEAK_Node_GetNamespace	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_NAMESPACE *	_namespace )

Asks the given node for its namespace.

Parameters

[in]	nodeHandle	The node.
[out]	_namespace	The namespace.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT _namespace is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetNumInvalidatedNodes()

PEAK_C_API PEAK_Node_GetNumInvalidatedNodes	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t *	numInvalidatedNodes )

Asks the given node for its number of invalidated nodes.

Parameters

[in]	nodeHandle	The node.
[out]	numInvalidatedNodes	The number of invalidated nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numInvalidatedNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetNumInvalidatingNodes()

PEAK_C_API PEAK_Node_GetNumInvalidatingNodes	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t *	numInvalidatingNodes )

Asks the given node for its number of invalidating nodes.

Parameters

[in]	nodeHandle	The node.
[out]	numInvalidatingNodes	The number of invalidating nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numInvalidatingNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetNumSelectedNodes()

PEAK_C_API PEAK_Node_GetNumSelectedNodes	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t *	numSelectedNodes )

Asks the given node for its number of selected nodes.

Parameters

[in]	nodeHandle	The node.
[out]	numSelectedNodes	The number of selected nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numSelectedNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetNumSelectingNodes()

PEAK_C_API PEAK_Node_GetNumSelectingNodes	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t *	numSelectingNodes )

Asks the given node for its number of selecting nodes.

Parameters

[in]	nodeHandle	The node.
[out]	numSelectingNodes	The number of selecting nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numSelectingNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetParentNodeMap()

PEAK_C_API PEAK_Node_GetParentNodeMap	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_MAP_HANDLE *	nodeMapHandle )

Asks the given node for its parent node map.

Parameters

[in]	nodeHandle	The node.
[out]	nodeMapHandle	The type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeMapHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetPollingTime()

PEAK_C_API PEAK_Node_GetPollingTime	(	PEAK_NODE_HANDLE	nodeHandle,
		int64_t *	pollingTime_ms )

Asks the given node for its polling time.

Parameters

[in]	nodeHandle	The node.
[out]	pollingTime_ms	The polling time in milliseconds.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT pollingTime_ms is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetSelectedNode()

PEAK_C_API PEAK_Node_GetSelectedNode	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	selectedNodeHandle )

Asks the given node for the selected node with the given index.

Parameters

[in]	nodeHandle	The node.
[in]	index	The index.
[out]	selectedNodeHandle	The selected node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT selectedNodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetSelectingNode()

PEAK_C_API PEAK_Node_GetSelectingNode	(	PEAK_NODE_HANDLE	nodeHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	selectingNodeHandle )

Asks the given node for the selecting node with the given index.

Parameters

[in]	nodeHandle	The node.
[in]	index	The index.
[out]	selectingNodeHandle	The selecting node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT selectingNodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetToolTip()

PEAK_C_API PEAK_Node_GetToolTip	(	PEAK_NODE_HANDLE	nodeHandle,
		char *	toolTip,
		size_t *	toolTipSize )

Asks the given node for its tooltip.

Parameters

[in]	nodeHandle	The node.
[out]	toolTip	The tooltip.
[in,out]	toolTipSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT toolTipSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL toolTipSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetType()

PEAK_C_API PEAK_Node_GetType	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_TYPE *	type )

Asks the given node for its type.

Parameters

[in]	nodeHandle	The node.
[out]	type	The type.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT type is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_GetVisibility()

PEAK_C_API PEAK_Node_GetVisibility	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_VISIBILITY *	visibility )

Asks the given node for its visibility.

Parameters

[in]	nodeHandle	The node.
[out]	visibility	The visibility.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT visibility is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_RegisterChangedCallback()

PEAK_C_API PEAK_Node_RegisterChangedCallback	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_CHANGED_CALLBACK	callback,
		void *	callbackContext,
		PEAK_NODE_CHANGED_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a change at the given node.

Parameters

[in]	nodeHandle	The node.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToBooleanNode()

PEAK_C_API PEAK_Node_ToBooleanNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_BOOLEAN_NODE_HANDLE *	booleanNodeHandle )

Casts the given node to a boolean node.

Parameters

[in]	nodeHandle	The node.
[out]	booleanNodeHandle	The boolean node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT booleanNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a boolean node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToCategoryNode()

PEAK_C_API PEAK_Node_ToCategoryNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_CATEGORY_NODE_HANDLE *	categoryNodeHandle )

Casts the given node to a category node.

Parameters

[in]	nodeHandle	The node.
[out]	categoryNodeHandle	The category node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT categoryNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a category node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToCommandNode()

PEAK_C_API PEAK_Node_ToCommandNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_COMMAND_NODE_HANDLE *	commandNodeHandle )

Casts the given node to a command node.

Parameters

[in]	nodeHandle	The node.
[out]	commandNodeHandle	The command node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT commandNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a command node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToEnumerationEntryNode()

PEAK_C_API PEAK_Node_ToEnumerationEntryNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_ENUMERATION_ENTRY_NODE_HANDLE *	enumerationEntryNodeHandle )

Casts the given node to an enumeration entry node.

Parameters

[in]	nodeHandle	The node.
[out]	enumerationEntryNodeHandle	The enumeration entry node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationEntryNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to an enumeration entry node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToEnumerationNode()

PEAK_C_API PEAK_Node_ToEnumerationNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_ENUMERATION_NODE_HANDLE *	enumerationNodeHandle )

Casts the given node to an enumeration node.

Parameters

[in]	nodeHandle	The node.
[out]	enumerationNodeHandle	The enumeration node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT enumerationNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to an enumeration node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToFloatNode()

PEAK_C_API PEAK_Node_ToFloatNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_FLOAT_NODE_HANDLE *	floatNodeHandle )

Casts the given node to a float node.

Parameters

[in]	nodeHandle	The node.
[out]	floatNodeHandle	The command node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT floatNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a float node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToIntegerNode()

PEAK_C_API PEAK_Node_ToIntegerNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_INTEGER_NODE_HANDLE *	integerNodeHandle )

Casts the given node to an integer node.

Parameters

[in]	nodeHandle	The node.
[out]	integerNodeHandle	The integer node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT integerNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to an integer node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToRegisterNode()

PEAK_C_API PEAK_Node_ToRegisterNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_REGISTER_NODE_HANDLE *	registerNodeHandle )

Casts the given node to a register node.

Parameters

[in]	nodeHandle	The node.
[out]	registerNodeHandle	The register node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT registerNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a register node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_ToStringNode()

PEAK_C_API PEAK_Node_ToStringNode	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_STRING_NODE_HANDLE *	stringNodeHandle )

Casts the given node to a string node.

Parameters

[in]	nodeHandle	The node.
[out]	stringNodeHandle	The string node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT stringNodeHandle is a null pointer

PEAK_RETURN_CODE_INVALID_CAST Node cannot be cast to a string node

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Node_UnregisterChangedCallback()

PEAK_C_API PEAK_Node_UnregisterChangedCallback	(	PEAK_NODE_HANDLE	nodeHandle,
		PEAK_NODE_CHANGED_CALLBACK_HANDLE	callbackHandle )

Unregisters the changed callback with the given handle from the given node.

Parameters

[in]	nodeHandle	The node.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_FindNode()

PEAK_C_API PEAK_NodeMap_FindNode	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	nodeName,
		size_t	nodeNameSize,
		PEAK_NODE_HANDLE *	nodeHandle )

Tells the given node map to find a node with the given name.

Parameters

[in]	nodeMapHandle	The node map.
[in]	nodeName	The name of the node to find.
[in]	nodeNameSize	The size of the name.
[out]	nodeHandle	The found node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeName and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_NOT_FOUND There is no node with the given name

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_GetHasBufferSupportedChunks()

PEAK_C_API PEAK_NodeMap_GetHasBufferSupportedChunks	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		PEAK_BUFFER_HANDLE	bufferHandle,
		PEAK_BOOL8 *	hasSupportedChunks )

Checks if the buffer contains chunks corresponding to the node map.

Parameters

[in]	nodeMapHandle	The node map.
[in]	bufferHandle	The new buffer to be parsed.
[out]	hasSupportedChunks	A flag telling whether the buffer can be parsed.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle or bufferHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasSupportedChunks is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_NodeMap_GetHasEventSupportedData()

PEAK_C_API PEAK_NodeMap_GetHasEventSupportedData	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		PEAK_EVENT_HANDLE	eventHandle,
		PEAK_BOOL8 *	hasSupportedData )

Checks if the event contains data corresponding to the node map.

Parameters

[in]	nodeMapHandle	The node map.
[in]	eventHandle	The new event to be parsed.
[out]	hasSupportedData	A flag telling whether the event can be parsed.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle or eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT hasSupportedData is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_NodeMap_GetHasNode()

PEAK_C_API PEAK_NodeMap_GetHasNode	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	nodeName,
		size_t	nodeNameSize,
		PEAK_BOOL8 *	hasNode )

Checks whether the given node map contains a node with the given name.

Parameters

[in]	nodeMapHandle	The node map.
[in]	nodeName	The name of the node to find.
[in]	nodeNameSize	The size of the name.
[out]	hasNode	A flag telling whether the given node map contains a node with the given name.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle or eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeName and/or hasNode are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_NodeMap_GetNode()

PEAK_C_API PEAK_NodeMap_GetNode	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		size_t	index,
		PEAK_NODE_HANDLE *	nodeHandle )

Asks the given node map for the node with the given index.

Parameters

[in]	nodeMapHandle	The node map.
[in]	index	The index.
[out]	nodeHandle	The node being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_GetNumNodes()

PEAK_C_API PEAK_NodeMap_GetNumNodes	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		size_t *	numNodes )

Asks the given node map for its number of nodes.

Parameters

[in]	nodeMapHandle	The node map.
[out]	numNodes	The number of nodes.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numNodes is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_InvalidateNodes()

PEAK_C_API PEAK_NodeMap_InvalidateNodes

(

PEAK_NODE_MAP_HANDLE

nodeMapHandle

)

Tells the given node map to invalidate its nodes.

Parameters

[in]

nodeMapHandle

The node map.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_LoadFromFile()

PEAK_C_API PEAK_NodeMap_LoadFromFile	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	filePath,
		size_t	filePathSize )

Tells the given node map to load the values of its streamable nodes from a file at the given file path.

The file to load has to use the GenApi persistence file format. It is not recommended to edit files using this format manually unless you are familiar with the GenApi persistence functionality.

Note

The filePath is UTF-8 encoded.

Parameters

[in]	nodeMapHandle	The node map.
[in]	filePath	The path of the file to load the node values from.
[in]	filePathSize	The size of the file path.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer or invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_NodeMap_Lock()

PEAK_C_API PEAK_NodeMap_Lock

(

PEAK_NODE_MAP_HANDLE

nodeMapHandle

)

Locks a recursive mutex on the NodeMap.

Use this to synchronize NodeMap access from multiple threads.

Note

Each individual access is already protected by this mutex, so the nodemap doesn't need to be locked for those. But often, nodemap access consists of multiple calls, e.g.: First, (1.) change a selector value (e.g. set "GainSelector" node to "DigitalRed"), then (2.) access a selected node (e.g. set value in "Gain" node). If a different thread changes the selector value between (1.) and (2.), (2.) will access the wrong selected node. These kinds of calls should be protected by this lock.

Parameters

[in]

nodeMapHandle

The node map.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_NodeMap_PollNodes()

PEAK_C_API PEAK_NodeMap_PollNodes	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		int64_t	elapsedTime_ms )

Tells the given node map to poll its nodes.

Parameters

[in]	nodeMapHandle	The node map.
[in]	elapsedTime_ms	The elapsed time since the last call in milliseconds.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_NodeMap_StoreToFile()

PEAK_C_API PEAK_NodeMap_StoreToFile	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	filePath,
		size_t	filePathSize )

Tells the given node map to store the values of its streamable nodes to a file at the given file path.

The stored file uses the GenApi persistence file format. It is not recommended to edit files using this format manually unless you are familiar with the GenApi persistence functionality.

Note

The filePath is UTF-8 encoded.

Parameters

[in]	nodeMapHandle	The node map.
[in]	filePath	The path of the file to store the node values.
[in]	filePathSize	The size of the file path.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT filePath is a null pointer or invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_NodeMap_TryFindNode()

PEAK_C_API PEAK_NodeMap_TryFindNode	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		const char *	nodeName,
		size_t	nodeNameSize,
		PEAK_NODE_HANDLE *	nodeHandle )

Tells the given node map to try to find a node with the given name.

Parameters

[in]	nodeMapHandle	The node map.
[in]	nodeName	The name of the node to find.
[in]	nodeNameSize	The size of the name.
[out]	nodeHandle	The found node or NULL if not found.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeName and/or nodeHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.10

PEAK_NodeMap_TryLock()

PEAK_C_API PEAK_NodeMap_TryLock	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		PEAK_BOOL8 *	locked )

Tries to Lock a recursive mutex on the NodeMap. Use this to synchronize NodeMap access from multiple threads. The call is non-blocking and the state is returned in locked. In case the lock was acquired, it must be released by a call to PEAK_NodeMap_Unlock when done.

Note

Each individual access is already protected by this mutex, so the nodemap doesn't need to be locked for those. But often, nodemap access consists of multiple calls, e.g.: First, (1.) change a selector value (e.g. set "GainSelector" node to "DigitalRed"), then (2.) access a selected node (e.g. set value in "Gain" node). If a different thread changes the selector value between (1.) and (2.), (2.) will access the wrong selected node. These kinds of calls should be protected by this lock.

Parameters

[in]	nodeMapHandle	The node map.
[out]	locked	Returns the state of the lock operation as a boolean. True if it was locked or false if the lock couldn't be acquired.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT locked is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.11

PEAK_NodeMap_Unlock()

PEAK_C_API PEAK_NodeMap_Unlock

(

PEAK_NODE_MAP_HANDLE

nodeMapHandle

)

Unlocks the recursive mutex on the NodeMap.

Parameters

[in]

nodeMapHandle

The node map.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_NodeMap_UpdateChunkNodes()

PEAK_C_API PEAK_NodeMap_UpdateChunkNodes	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		PEAK_BUFFER_HANDLE	bufferHandle )

Updates chunk information in the node map.

When chunks are active, pass each new buffer to this method to parse the chunks and update the corresponding chunk nodes in the NodeMap.

Parameters

[in]	nodeMapHandle	The node map.
[in]	bufferHandle	The new buffer to be parsed.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle or bufferHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.1

PEAK_NodeMap_UpdateEventNodes()

PEAK_C_API PEAK_NodeMap_UpdateEventNodes	(	PEAK_NODE_MAP_HANDLE	nodeMapHandle,
		PEAK_EVENT_HANDLE	eventHandle )

Updates event information in the node map.

When events are active, pass each new event to this method to parse the event data and update the corresponding nodes in the NodeMap.

Parameters

[in]	nodeMapHandle	The node map.
[in]	eventHandle	The new event to be parsed.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE nodeMapHandle or eventHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT Event does not have supported data

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.2

PEAK_Port_GetDataEndianness()

PEAK_C_API PEAK_Port_GetDataEndianness	(	PEAK_PORT_HANDLE	portHandle,
		PEAK_ENDIANNESS *	dataEndianness )

Asks the given port for its data endianness.

Parameters

[in]	portHandle	The port.
[out]	dataEndianness	The data endianness.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT dataEndianness is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetID()

PEAK_C_API PEAK_Port_GetID	(	PEAK_PORT_HANDLE	portHandle,
		char *	id,
		size_t *	idSize )

Asks the given port for its ID.

Parameters

[in]	portHandle	The port.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetInfo()

PEAK_C_API PEAK_Port_GetInfo	(	PEAK_PORT_HANDLE	portHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given port for an information based on a specific command.

Parameters

[in]	portHandle	The port.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetIsAvailable()

PEAK_C_API PEAK_Port_GetIsAvailable	(	PEAK_PORT_HANDLE	portHandle,
		PEAK_BOOL8 *	isAvailable )

Asks the given port whether it is available.

Parameters

[in]	portHandle	The port.
[out]	isAvailable	A flag telling whether the port is available.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isAvailable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetIsImplemented()

PEAK_C_API PEAK_Port_GetIsImplemented	(	PEAK_PORT_HANDLE	portHandle,
		PEAK_BOOL8 *	isImplemented )

Asks the given port whether it is implemented.

Parameters

[in]	portHandle	The port.
[out]	isImplemented	A flag telling whether the port is implemented.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isImplemented is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetIsReadable()

PEAK_C_API PEAK_Port_GetIsReadable	(	PEAK_PORT_HANDLE	portHandle,
		PEAK_BOOL8 *	isReadable )

Asks the given port whether it is readable.

Parameters

[in]	portHandle	The port.
[out]	isReadable	A flag telling whether the port is readable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isReadable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetIsWritable()

PEAK_C_API PEAK_Port_GetIsWritable	(	PEAK_PORT_HANDLE	portHandle,
		PEAK_BOOL8 *	isWritable )

Asks the given port whether it is writable.

Parameters

[in]	portHandle	The port.
[out]	isWritable	A flag telling whether the port is writable.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT isWritable is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetModelName()

PEAK_C_API PEAK_Port_GetModelName	(	PEAK_PORT_HANDLE	portHandle,
		char *	modelName,
		size_t *	modelNameSize )

Asks the given port for its model name.

Parameters

[in]	portHandle	The port.
[out]	modelName	The model name.
[in,out]	modelNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT modelNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL modelNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetModuleName()

PEAK_C_API PEAK_Port_GetModuleName	(	PEAK_PORT_HANDLE	portHandle,
		char *	moduleName,
		size_t *	moduleNameSize )

Asks the given port for its module name.

Parameters

[in]	portHandle	The port.
[out]	moduleName	The module name.
[in,out]	moduleNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL moduleNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetName()

PEAK_C_API PEAK_Port_GetName	(	PEAK_PORT_HANDLE	portHandle,
		char *	name,
		size_t *	nameSize )

Asks the given port for its name.

Parameters

[in]	portHandle	The port.
[out]	name	The name.
[in,out]	nameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL nameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetNumURLs()

PEAK_C_API PEAK_Port_GetNumURLs	(	PEAK_PORT_HANDLE	portHandle,
		size_t *	numUrls )

Asks the given port for its number of URLs.

Parameters

[in]	portHandle	The port.
[out]	numUrls	The number of URLs.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT numUrls is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetTLType()

PEAK_C_API PEAK_Port_GetTLType	(	PEAK_PORT_HANDLE	portHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given port for its TL type.

Parameters

[in]	portHandle	The port.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetURL()

PEAK_C_API PEAK_Port_GetURL	(	PEAK_PORT_HANDLE	portHandle,
		size_t	index,
		PEAK_PORT_URL_HANDLE *	portUrlHandle )

Asks the given port for the URL with the given index.

Parameters

[in]	portHandle	The port.
[in]	index	The index.
[out]	portUrlHandle	The URL being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT portUrlHandle is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetVendorName()

PEAK_C_API PEAK_Port_GetVendorName	(	PEAK_PORT_HANDLE	portHandle,
		char *	vendorName,
		size_t *	vendorNameSize )

Asks the given port for its vendor name.

Parameters

[in]	portHandle	The port.
[out]	vendorName	The vendor name.
[in,out]	vendorNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT vendorNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL vendorNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_GetVersion()

PEAK_C_API PEAK_Port_GetVersion	(	PEAK_PORT_HANDLE	portHandle,
		char *	version,
		size_t *	versionSize )

Asks the given port for its version.

Parameters

[in]	portHandle	The port.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_Read()

PEAK_C_API PEAK_Port_Read	(	PEAK_PORT_HANDLE	portHandle,
		uint64_t	address,
		uint8_t *	bytesToRead,
		size_t	bytesToReadSize )

Tells the given port to read the given amount of bytes at the given address.

Parameters

[in]	portHandle	The port.
[in]	address	The address.
[out]	bytesToRead	The buffer for the bytes to read.
[in]	bytesToReadSize	The amount of bytes to read.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ADDRESS address is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bytesToRead is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_Port_Write()

PEAK_C_API PEAK_Port_Write	(	PEAK_PORT_HANDLE	portHandle,
		uint64_t	address,
		const uint8_t *	bytesToWrite,
		size_t	bytesToWriteSize )

Tells the given port to write the given amount of bytes at the given address.

Parameters

[in]	portHandle	The port.
[in]	address	The address.
[in]	bytesToWrite	The bytes to write.
[in]	bytesToWriteSize	The amount of bytes to write.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_OUT_OF_RANGE The given value is out of range

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ADDRESS address is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT bytesToWrite is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE portHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileName()

PEAK_C_API PEAK_PortURL_GetFileName	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		char *	fileName,
		size_t *	fileNameSize )

Asks the given port URL for its file name.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileName	The file name.
[in,out]	fileNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL fileNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileRegisterAddress()

PEAK_C_API PEAK_PortURL_GetFileRegisterAddress	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		uint64_t *	fileRegisterAddress )

Asks the given port URL for its file register address.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileRegisterAddress	The file register address.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileRegisterAddress is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileSchemaVersionMajor()

PEAK_C_API PEAK_PortURL_GetFileSchemaVersionMajor	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t *	fileSchemaVersionMajor )

Asks the given port URL for the major component of its file schema version.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileSchemaVersionMajor	The major component of the file schema version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileSchemaVersionMajor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileSchemaVersionMinor()

PEAK_C_API PEAK_PortURL_GetFileSchemaVersionMinor	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t *	fileSchemaVersionMinor )

Asks the given port URL for the minor component of its file schema version.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileSchemaVersionMinor	The minor component of the file schema version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileSchemaVersionMinor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileSHA1Hash()

PEAK_C_API PEAK_PortURL_GetFileSHA1Hash	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		uint8_t *	fileSha1Hash,
		size_t *	fileSha1HashSize )

Asks the given port URL for its file SHA1 hash.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileSha1Hash	The file SHA1 hash.
[in,out]	fileSha1HashSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileSha1HashSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileSize()

PEAK_C_API PEAK_PortURL_GetFileSize	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		uint64_t *	fileSize )

Asks the given port URL for its file size.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileSize	The file size.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileVersionMajor()

PEAK_C_API PEAK_PortURL_GetFileVersionMajor	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t *	fileVersionMajor )

Asks the given port URL for the major component of its file version.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileVersionMajor	The major component of the file version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileVersionMajor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileVersionMinor()

PEAK_C_API PEAK_PortURL_GetFileVersionMinor	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t *	fileVersionMinor )

Asks the given port URL for the minor component of its file version.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileVersionMinor	The minor component of the file version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileVersionMinor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetFileVersionSubminor()

PEAK_C_API PEAK_PortURL_GetFileVersionSubminor	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t *	fileVersionSubminor )

Asks the given port URL for the subminor component of its file version.

Parameters

[in]	portUrlHandle	The port URL.
[out]	fileVersionSubminor	The subminor component of the file version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT fileVersionSubminor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetInfo()

PEAK_C_API PEAK_PortURL_GetInfo	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given port URL for an information based on a specific command.

Parameters

[in]	portUrlHandle	The port URL.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetParentPort()

PEAK_C_API PEAK_PortURL_GetParentPort	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		PEAK_PORT_HANDLE *	portHandle )

Asks the given port URL for its parent port.

Parameters

[in]	portUrlHandle	The port URL.
[out]	portHandle	The parent port.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT portHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetScheme()

PEAK_C_API PEAK_PortURL_GetScheme	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		PEAK_PORT_URL_SCHEME *	scheme )

Asks the given port URL for its scheme.

Parameters

[in]	portUrlHandle	The port URL.
[out]	scheme	The scheme.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT scheme is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_PortURL_GetURL()

PEAK_C_API PEAK_PortURL_GetURL	(	PEAK_PORT_URL_HANDLE	portUrlHandle,
		char *	url,
		size_t *	urlSize )

Asks the given port URL for its URL string.

Parameters

[in]	portUrlHandle	The port URL.
[out]	url	The URL string.
[in,out]	urlSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE portUrlHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT urlSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL urlSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_ProducerLibrary_Construct()

PEAK_C_API PEAK_ProducerLibrary_Construct	(	const char *	ctiPath,
		size_t	ctiPathSize,
		PEAK_PRODUCER_LIBRARY_HANDLE *	producerLibraryHandle )

Creates a producer library.

Parameters

[in]	ctiPath	The CTI to create the producer library from.
[in]	ctiPathSize	The size of the given string.
[out]	producerLibraryHandle	The handle associated with the producer library.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiPath and/or producerLibraryHandle are/is a null pointer

PEAK_RETURN_CODE_CTI_LOADING_ERROR Error on loading the cti

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_ProducerLibrary_Destruct()

PEAK_C_API PEAK_ProducerLibrary_Destruct

(

PEAK_PRODUCER_LIBRARY_HANDLE

producerLibraryHandle

)

Destroys the given producer library.

Parameters

[in]

producerLibraryHandle

The producer library.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE producerLibraryHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_ProducerLibrary_GetKey()

PEAK_C_API PEAK_ProducerLibrary_GetKey	(	PEAK_PRODUCER_LIBRARY_HANDLE	producerLibraryHandle,
		char *	key,
		size_t *	keySize )

Asks the given producer library for its key.

Parameters

[in]	producerLibraryHandle	The producer library.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE producerLibraryHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_ProducerLibrary_GetSystem()

PEAK_C_API PEAK_ProducerLibrary_GetSystem	(	PEAK_PRODUCER_LIBRARY_HANDLE	producerLibraryHandle,
		PEAK_SYSTEM_DESCRIPTOR_HANDLE *	systemDescriptorHandle )

Asks the given producer library for its system descriptor.

Parameters

[in]	producerLibraryHandle	The producer library.
[out]	systemDescriptorHandle	The system descriptor.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE producerLibraryHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT systemDescriptorHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RegisterNode_GetAddress()

PEAK_C_API PEAK_RegisterNode_GetAddress	(	PEAK_REGISTER_NODE_HANDLE	registerNodeHandle,
		uint64_t *	address )

Asks the given register node for its address.

Parameters

[in]	registerNodeHandle	The register node.
[out]	address	The address.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE registerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT address is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RegisterNode_GetLength()

PEAK_C_API PEAK_RegisterNode_GetLength	(	PEAK_REGISTER_NODE_HANDLE	registerNodeHandle,
		size_t *	length )

Asks the given register node for its length.

Parameters

[in]	registerNodeHandle	The register node.
[out]	length	The length.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE registerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT length is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RegisterNode_Read()

PEAK_C_API PEAK_RegisterNode_Read	(	PEAK_REGISTER_NODE_HANDLE	registerNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		uint8_t *	bytesToRead,
		size_t	bytesToReadSize )

Tells the given register node to read the given amount of bytes.

Parameters

[in]	registerNodeHandle	The register node.
[in]	cacheUsePolicy	The cache use policy.
[out]	bytesToRead	The bytes to read.
[in]	bytesToReadSize	The amount of bytes to read.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT bytesToRead is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RegisterNode_ToNode()

PEAK_C_API PEAK_RegisterNode_ToNode	(	PEAK_REGISTER_NODE_HANDLE	registerNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given register node to a node.

Parameters

[in]	registerNodeHandle	The register node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE registerNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RegisterNode_Write()

PEAK_C_API PEAK_RegisterNode_Write	(	PEAK_REGISTER_NODE_HANDLE	registerNodeHandle,
		const uint8_t *	bytesToWrite,
		size_t	bytesToWriteSize )

Tells the given register node to write the given bytes.

Parameters

[in]	registerNodeHandle	The register node.
[out]	bytesToWrite	The bytes to write.
[in]	bytesToWriteSize	The amount of bytes to write.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_ARGUMENT bytesToWrite is a null pointer

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RemoteDevice_GetLocalDevice()

PEAK_C_API PEAK_RemoteDevice_GetLocalDevice	(	PEAK_REMOTE_DEVICE_HANDLE	remoteDeviceHandle,
		PEAK_DEVICE_HANDLE *	deviceHandle )

Asks the given remote device for its local device.

Parameters

[in]	remoteDeviceHandle	The remote device.
[out]	deviceHandle	The local device.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE remoteDeviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT deviceHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_RemoteDevice_ToModule()

PEAK_C_API PEAK_RemoteDevice_ToModule	(	PEAK_REMOTE_DEVICE_HANDLE	remoteDeviceHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given remote device to a module.

Parameters

[in]	remoteDeviceHandle	The remote device.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE remoteDeviceHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_StringNode_GetMaximumLength()

PEAK_C_API PEAK_StringNode_GetMaximumLength	(	PEAK_STRING_NODE_HANDLE	stringNodeHandle,
		int64_t *	maximumLength )

Asks the given string node for its maximum length.

Parameters

[in]	stringNodeHandle	The string node.
[out]	maximumLength	The maximum length.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT maximumLength is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_StringNode_GetValue()

PEAK_C_API PEAK_StringNode_GetValue	(	PEAK_STRING_NODE_HANDLE	stringNodeHandle,
		PEAK_NODE_CACHE_USE_POLICY	cacheUsePolicy,
		char *	value,
		size_t *	valueSize )

Asks the given string node for its value.

Parameters

[in]	stringNodeHandle	The string node.
[in]	cacheUsePolicy	The cache use policy.
[out]	value	The value.
[in,out]	valueSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT valueSize is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_StringNode_SetValue()

PEAK_C_API PEAK_StringNode_SetValue	(	PEAK_STRING_NODE_HANDLE	stringNodeHandle,
		const char *	value,
		size_t	valueSize )

Tells the given string node to set the given value.

Parameters

[in]	stringNodeHandle	The string node.
[in]	value	The value.
[in]	valueSize	The size of the value.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_IO A communication error has occured, e.g. when the device gets unexpectedly disconnected during the update process.

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_StringNode_ToNode()

PEAK_C_API PEAK_StringNode_ToNode	(	PEAK_STRING_NODE_HANDLE	stringNodeHandle,
		PEAK_NODE_HANDLE *	nodeHandle )

Casts the given string node to a node.

Parameters

[in]	stringNodeHandle	The string node.
[out]	nodeHandle	The node.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE stringNodeHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT nodeHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_Destruct()

PEAK_C_API PEAK_System_Destruct

(

PEAK_SYSTEM_HANDLE

systemHandle

)

Destroys the given system.

Parameters

[in]

systemHandle

The system.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetCharacterEncoding()

PEAK_C_API PEAK_System_GetCharacterEncoding	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_CHARACTER_ENCODING *	characterEncoding )

Asks the given system for its character encoding.

Parameters

[in]	systemHandle	The system.
[out]	characterEncoding	The character encoding.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT characterEncoding is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetCTIFileName()

PEAK_C_API PEAK_System_GetCTIFileName	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	ctiFileName,
		size_t *	ctiFileNameSize )

Asks the given system for its parent CTI's file name.

Parameters

[in]	systemHandle	The system.
[out]	ctiFileName	The parent CTI's file name.
[in,out]	ctiFileNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiFileNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL ctiFileNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetCTIFullPath()

PEAK_C_API PEAK_System_GetCTIFullPath	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	ctiFullPath,
		size_t *	ctiFullPathSize )

Asks the given system for its parent CTI's full path.

Parameters

[in]	systemHandle	The system.
[out]	ctiFullPath	The parent CTI's full path.
[in,out]	ctiFullPathSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiFullPathSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL ctiFullPathSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetDisplayName()

PEAK_C_API PEAK_System_GetDisplayName	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given system for its display name.

Parameters

[in]	systemHandle	The system.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetGenTLVersionMajor()

PEAK_C_API PEAK_System_GetGenTLVersionMajor	(	PEAK_SYSTEM_HANDLE	systemHandle,
		uint32_t *	gentlVersionMajor )

Asks the given system for the major component of its GenTL version.

Parameters

[in]	systemHandle	The system.
[out]	gentlVersionMajor	The major component of the GenTL version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT gentlVersionMajor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetGenTLVersionMinor()

PEAK_C_API PEAK_System_GetGenTLVersionMinor	(	PEAK_SYSTEM_HANDLE	systemHandle,
		uint32_t *	gentlVersionMinor )

Asks the given system for the minor component of its GenTL version.

Parameters

[in]	systemHandle	The system.
[out]	gentlVersionMinor	The minor component of the GenTL version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT gentlVersionMinor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetID()

PEAK_C_API PEAK_System_GetID	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	id,
		size_t *	idSize )

Asks the given system for its ID.

Parameters

[in]	systemHandle	The system.
[out]	id	The ID.
[in,out]	idSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT idSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL idSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetInfo()

PEAK_C_API PEAK_System_GetInfo	(	PEAK_SYSTEM_HANDLE	systemHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given system for an information based on a specific command.

Parameters

[in]	systemHandle	The system.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetInterface()

PEAK_C_API PEAK_System_GetInterface	(	PEAK_SYSTEM_HANDLE	systemHandle,
		size_t	index,
		PEAK_INTERFACE_DESCRIPTOR_HANDLE *	interfaceDescriptorHandle )

Asks the given system for the interface descriptor with the given index.

Parameters

[in]	systemHandle	The system.
[in]	index	The index.
[out]	interfaceDescriptorHandle	The interface descriptor being associated with the given index.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT interfaceDescriptorHandle is a null pointer

PEAK_RETURN_CODE_OUT_OF_RANGE index is out of range

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetKey()

PEAK_C_API PEAK_System_GetKey	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	key,
		size_t *	keySize )

Asks the given system for its key.

Parameters

[in]	systemHandle	The system.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetModelName()

PEAK_C_API PEAK_System_GetModelName	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	modelName,
		size_t *	modelNameSize )

Asks the given system for its model name.

Parameters

[in]	systemHandle	The system.
[out]	modelName	The model name.
[in,out]	modelNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT modelNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL modelNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetNumInterfaces()

PEAK_C_API PEAK_System_GetNumInterfaces	(	PEAK_SYSTEM_HANDLE	systemHandle,
		size_t *	numInterfaces )

Asks the given system for its number of interfaces.

Parameters

[in]	systemHandle	The system.
[out]	numInterfaces	The number of interfaces.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT numInterfaces is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetParentLibrary()

PEAK_C_API PEAK_System_GetParentLibrary	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_PRODUCER_LIBRARY_HANDLE *	producerLibraryHandle )

Asks the given system for its parent library.

Parameters

[in]	systemHandle	The system.
[out]	producerLibraryHandle	The parent library.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT producerLibraryHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetTLType()

PEAK_C_API PEAK_System_GetTLType	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given system for its TL type.

Parameters

[in]	systemHandle	The system.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetVendorName()

PEAK_C_API PEAK_System_GetVendorName	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	vendorName,
		size_t *	vendorNameSize )

Asks the given system for its vendor name.

Parameters

[in]	systemHandle	The system.
[out]	vendorName	The vendor name.
[in,out]	vendorNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT vendorNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL vendorNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_GetVersion()

PEAK_C_API PEAK_System_GetVersion	(	PEAK_SYSTEM_HANDLE	systemHandle,
		char *	version,
		size_t *	versionSize )

Asks the given system for its version.

Parameters

[in]	systemHandle	The system.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_RegisterInterfaceFoundCallback()

PEAK_C_API PEAK_System_RegisterInterfaceFoundCallback	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_INTERFACE_FOUND_CALLBACK	callback,
		void *	callbackContext,
		PEAK_INTERFACE_FOUND_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a found interface at the given system.

Parameters

[in]	systemHandle	The system.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_RegisterInterfaceLostCallback()

PEAK_C_API PEAK_System_RegisterInterfaceLostCallback	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_INTERFACE_LOST_CALLBACK	callback,
		void *	callbackContext,
		PEAK_INTERFACE_LOST_CALLBACK_HANDLE *	callbackHandle )

Registers a callback signaling a lost interface at the given system.

Parameters

[in]	systemHandle	The system.
[in]	callback	The callback.
[in]	callbackContext	The callback context.
[out]	callbackHandle	The handle for the registered callback.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT callback and/or callbackHandle are/is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_ToEventSupportingModule()

PEAK_C_API PEAK_System_ToEventSupportingModule	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_EVENT_SUPPORTING_MODULE_HANDLE *	eventSupportingModuleHandle )

Casts the given system to an event-supporting module.

Parameters

[in]	systemHandle	The system.
[out]	eventSupportingModuleHandle	The event-supporting module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT eventSupportingModuleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_ToModule()

PEAK_C_API PEAK_System_ToModule	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_MODULE_HANDLE *	moduleHandle )

Casts the given system to a module.

Parameters

[in]	systemHandle	The system.
[out]	moduleHandle	The module.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_UnregisterInterfaceFoundCallback()

PEAK_C_API PEAK_System_UnregisterInterfaceFoundCallback	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_INTERFACE_FOUND_CALLBACK_HANDLE	callbackHandle )

Unregisters the interface-found callback with the given handle from the given system.

Parameters

[in]	systemHandle	The system.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_UnregisterInterfaceLostCallback()

PEAK_C_API PEAK_System_UnregisterInterfaceLostCallback	(	PEAK_SYSTEM_HANDLE	systemHandle,
		PEAK_INTERFACE_LOST_CALLBACK_HANDLE	callbackHandle )

Unregisters the interface-lost callback with the given handle from the given system.

Parameters

[in]	systemHandle	The system.
[in]	callbackHandle	The handle of the callback to unregister.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_System_UpdateInterfaces()

PEAK_C_API PEAK_System_UpdateInterfaces	(	PEAK_SYSTEM_HANDLE	systemHandle,
		uint64_t	timeout_ms )

Tells the given system to update its interfaces with the given timeout.

Parameters

[in]	systemHandle	The system.
[in]	timeout_ms	The time to wait for discovery.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemHandle is invalid

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetCharacterEncoding()

PEAK_C_API PEAK_SystemDescriptor_GetCharacterEncoding	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		PEAK_CHARACTER_ENCODING *	characterEncoding )

Asks the given system descriptor for its character encoding.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	characterEncoding	The character encoding.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT characterEncoding is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetCTIFileName()

PEAK_C_API PEAK_SystemDescriptor_GetCTIFileName	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	ctiFileName,
		size_t *	ctiFileNameSize )

Asks the given system descriptor for its parent CTI's file name.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	ctiFileName	The parent CTI's file name.
[in,out]	ctiFileNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiFileNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL ctiFileNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetCTIFullPath()

PEAK_C_API PEAK_SystemDescriptor_GetCTIFullPath	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	ctiFullPath,
		size_t *	ctiFullPathSize )

Asks the given system descriptor for its parent CTI's full path.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	ctiFullPath	The parent CTI's full path.
[in,out]	ctiFullPathSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT ctiFullPathSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL ctiFullPathSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetDisplayName()

PEAK_C_API PEAK_SystemDescriptor_GetDisplayName	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	displayName,
		size_t *	displayNameSize )

Asks the given system descriptor for its display name.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	displayName	The display name.
[in,out]	displayNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT displayNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL displayNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetGenTLVersionMajor()

PEAK_C_API PEAK_SystemDescriptor_GetGenTLVersionMajor	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		uint32_t *	gentlVersionMajor )

Asks the given system descriptor for the major component of its GenTL version.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	gentlVersionMajor	The major component of the GenTL version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT gentlVersionMajor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetGenTLVersionMinor()

PEAK_C_API PEAK_SystemDescriptor_GetGenTLVersionMinor	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		uint32_t *	gentlVersionMinor )

Asks the given system descriptor for the minor component of its GenTL version.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	gentlVersionMinor	The minor component of the GenTL version.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT gentlVersionMinor is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetInfo()

PEAK_C_API PEAK_SystemDescriptor_GetInfo	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		int32_t	infoCommand,
		int32_t *	infoDataType,
		uint8_t *	info,
		size_t *	infoSize )

Asks the given system descriptor for an information based on a specific command.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[in]	infoCommand	The command of interest.
[out]	infoDataType	The data type of the returned information data.
[out]	info	The returned information data.
[in,out]	infoSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT infoDataType and/or infoSize are/is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL infoSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetKey()

PEAK_C_API PEAK_SystemDescriptor_GetKey	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	key,
		size_t *	keySize )

Asks the given system descriptor for its key.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	key	The key.
[in,out]	keySize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT keySize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL keySize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetModelName()

PEAK_C_API PEAK_SystemDescriptor_GetModelName	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	modelName,
		size_t *	modelNameSize )

Asks the given system descriptor for its model name.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	modelName	The model name.
[in,out]	modelNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT modelNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL modelNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetParentLibrary()

PEAK_C_API PEAK_SystemDescriptor_GetParentLibrary	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		PEAK_PRODUCER_LIBRARY_HANDLE *	producerLibraryHandle )

Asks the given system descriptor for its parent library.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	producerLibraryHandle	The parent library.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT producerLibraryHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetTLType()

PEAK_C_API PEAK_SystemDescriptor_GetTLType	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	tlType,
		size_t *	tlTypeSize )

Asks the given system descriptor for its TL type.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	tlType	The TL type.
[in,out]	tlTypeSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT tlTypeSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL tlTypeSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetVendorName()

PEAK_C_API PEAK_SystemDescriptor_GetVendorName	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	vendorName,
		size_t *	vendorNameSize )

Asks the given system descriptor for its vendor name.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	vendorName	The vendor name.
[in,out]	vendorNameSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT vendorNameSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL vendorNameSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_GetVersion()

PEAK_C_API PEAK_SystemDescriptor_GetVersion	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		char *	version,
		size_t *	versionSize )

Asks the given system descriptor for its version.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	version	The version.
[in,out]	versionSize	IN: Size of the given buffer - OUT: Size of the returned data

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT versionSize is a null pointer

PEAK_RETURN_CODE_BUFFER_TOO_SMALL versionSize is too small

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_OpenSystem()

PEAK_C_API PEAK_SystemDescriptor_OpenSystem	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		PEAK_SYSTEM_HANDLE *	systemHandle )

Opens the system being associated with the given system descriptor.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	systemHandle	The system.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT systemHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0

PEAK_SystemDescriptor_ToModuleDescriptor()

PEAK_C_API PEAK_SystemDescriptor_ToModuleDescriptor	(	PEAK_SYSTEM_DESCRIPTOR_HANDLE	systemDescriptorHandle,
		PEAK_MODULE_DESCRIPTOR_HANDLE *	moduleDescriptorHandle )

Casts the given system descriptor to a module descriptor.

Parameters

[in]	systemDescriptorHandle	The system descriptor.
[out]	moduleDescriptorHandle	The module descriptor.

Returns

PEAK_RETURN_CODE_SUCCESS Everything was fine

PEAK_RETURN_CODE_INVALID_HANDLE systemDescriptorHandle is invalid

PEAK_RETURN_CODE_INVALID_ARGUMENT moduleDescriptorHandle is a null pointer

PEAK_RETURN_CODE_ERROR An internal error has occurred.

Since

1.0