iqr_version.h File Reference

ISARA Radiate Security Solution Suite toolkit version and build information. More...

Macros
#define	IQR_VERSION_MAJOR   1
#define	IQR_VERSION_MINOR   5
#define	IQR_VERSION_STRING   "ISARA Radiate Security Solution Suite 1.5"

Functions
IQR_API iqr_retval	iqr_VersionCheck (uint32_t version_major, uint32_t version_minor)
IQR_API iqr_retval	iqr_VersionGetBuildTarget (const char **build_target)
IQR_API iqr_retval	iqr_VersionGetBuildHash (const char **build_hash)

Macro Definition Documentation

IQR_VERSION_MAJOR

#define IQR_VERSION_MAJOR   1

The major and minor version numbers of the library.

For example, if:

• IQR_VERSION_MAJOR = 1
• IQR_VERSION_MINOR = 5

you are using version 1.5 of the library.

IQR_VERSION_MINOR

#define IQR_VERSION_MINOR   5

IQR_VERSION_STRING

#define IQR_VERSION_STRING   "ISARA Radiate Security Solution Suite 1.5"

A string representation of the library's version, including its full name and whether it was built with FIPS 140-2 support.

Function Documentation

iqr_VersionCheck()

IQR_API iqr_retval iqr_VersionCheck	(	uint32_t	version_major,
		uint32_t	version_minor
	)

Check library version.

Does the current library match the headers used to compile?

Parameters

[in]	version_major	Major version number (use IQR_VERSION_MAJOR).
[in]	version_minor	Minor version number (use IQR_VERSION_MINOR).

Returns

IQR_OK when the library matches the headers, or a value from iqr_retval.h when an error occurs.

iqr_VersionGetBuildHash()

IQR_API iqr_retval iqr_VersionGetBuildHash

(

const char **

build_hash

)

Get the library build hash.

Returns a pointer to a string representation of the library's build hash and configuration time defined when building the library. The string is delimited by a / character: BUILD_HASH/CONFIG_TIME

Note that the build_hash will be a pointer to a constant string in the library; you don't need to free the pointer, and you shouldn't modify its contents.

Parameters

[out]

build_hash

Pointer to a string representing the build hash.

Returns

IQR_OK or an error value from iqr_retval.h.

iqr_VersionGetBuildTarget()

IQR_API iqr_retval iqr_VersionGetBuildTarget

(

const char **

build_target

)

Get the library build information.

Returns a pointer to a string representation of the target OS, target CPU and compiler defined when building the library. The string is delimited by / characters: TARGET_OS/TARGET_CPU/COMPILER

Note that the build_target will be a pointer to a constant string in the library; you don't need to free the pointer, and you shouldn't modify its contents.

Parameters

[out]

build_target

Pointer to a string representing the build info.

Returns

IQR_OK or an error value from iqr_retval.h.

Detailed Description

ISARA Radiate Security Solution Suite toolkit version and build information.

This header provides version information for this build of the toolkit, as well as some version related convenience functions.

Copyright

Copyright 2015-2018, ISARA Corporation, All Rights Reserved.

License

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@.nosp@m.isar.nosp@m.a.com for more information.