Types and functions for operating with bRAWcap version(s). More...

Data Structures
struct	brawcap_version_fragments_t
	Struct containing the separated version parts. More...

union	brawcap_version_t
	bRAWcap version. More...

Functions
brawcap_status_t	brawcap_version_api (brawcap_version_t *const pVersion)
	Returns loaded bRAWcap library version.

brawcap_status_t	brawcap_version_driver (brawcap_handle_t const pHandle, brawcap_version_t const pVersion)
	Reads current version of loaded bRAWcap driver.

Detailed Description

Types and functions for operating with bRAWcap version(s).

Here our bRAWcap version structure is defined. This structure allows easy access to each part of the version and due to it´s union the complete value can be used for easy version compares.

There are currently two functions to retrieve a version. One for the version of the loaded library and another one for the version of the loaded bRAWcap driver on the machine.

Attention: In general both versions shall be equal. This means it is not allowed to deploy copys of the bRAWcap library with any application. Instead always the bRAWcap library from system path shall be used (which will be deployed by the bRAWcap setup). This avoids communication issues between the driver and the library. If there are any issues with driver communication, please check that the driver and library version matches.

List of examples:

Version Comparator

Data Structure Documentation

◆ brawcap_version_fragments_t

struct brawcap_version_fragments_t

Struct containing the separated version parts.

Data Fields
UINT16	build	Build version. Different for each build. Releases will always have different version by the upper three values. Versions with different build versions only should not appear. API and ABI always stays compatible between different build versions.
UINT16	patch	Patch version. Different for each bugfix release. Will be increased if the release contains bugfixes only. API and ABI always stays compatible between different patch versions.
UINT16	minor	Minor version. Different for each minor release. Will be increased if the release contains new features (and maybe some bugfixes). API always stays compatible between different minor versions.
UINT16	major	Major version. Different for each major release. Will be increased if for example some features have removed or changed in a way which would break the API compatibility. API compatibility between different major versions is not guaranteed.

◆ brawcap_version_t

union brawcap_version_t

bRAWcap version.

The version is implemented as a union. The complete member allows easy compare between versions. While the fragments allow easy access to each version part (major, minor, patch, build).

Examples: 04_version_comparator.c.

Data Fields
brawcap_version_fragments_t	fragments	Separated parts of the version.
UINT64	complete	Complete version as integer. Use this for comparing versions.

Function Documentation

◆ brawcap_version_api()

brawcap_status_t brawcap_version_api ( brawcap_version_t *const pVersion )

#include <brawcap.h>

Returns loaded bRAWcap library version.

Parameters

[out] pVersion Will contain the loaded library version, afterwards.

Returns

Status	Description
BRAWCAP_STATUS_SUCCESS	Success.
BRAWCAP_STATUS_ERROR_INVALID_POINTER	At least one of the pointer parameters was invalid.

Examples: 04_version_comparator.c.

◆ brawcap_version_driver()

brawcap_status_t brawcap_version_driver	(	brawcap_handle_t *const	pHandle,
		brawcap_version_t *const	pVersion
	)