Version

Classes
struct	face_sdk__version_info
	The version_info class provides information about FaceSDK version. See Available algorightm versions and versions compatibility. More...

Typedefs
typedef struct face_sdk__version_info	face_sdk__version_info_t
	The version_info class provides information about FaceSDK version. See Available algorightm versions and versions compatibility.

Functions
bool	face_sdk__version_info__get_addr (const face_sdk__version_info_t *version_info, uint64_t *addr)
	Retrieves face_sdk__version_info_t object address * *. More...
bool	face_sdk__version_info__get_major (const face_sdk__version_info_t *version_info, uint32_t *value)
	Retrieves major version of FaceSDK. More...
bool	face_sdk__version_info__get_minor (const face_sdk__version_info_t *version_info, uint32_t *value)
	Retrieves minor version of FaceSDK. More...
bool	face_sdk__version_info__get_patch (const face_sdk__version_info_t *version_info, uint32_t *value)
	Retrieves patch version of FaceSDK. More...
bool	face_sdk__version_info__get_code_name (const face_sdk__version_info_t *version_info, uint8_t **string_buffer, uint64_t *string_buffer_len)
	Retrieves code name of FaceSDK. More...
bool	face_sdk__version_info__get_git_commit (const face_sdk__version_info_t *version_info, uint8_t **string_buffer, uint64_t *string_buffer_len)
	Retrieves git commit hash of FaceSDK build. More...
bool	face_sdk__version_info__get_full_version_string (const face_sdk__version_info_t *version_info, uint8_t **string_buffer, uint64_t *string_buffer_size)
	Retrieves full version string: "major.minor code_name (git_commit)". More...
bool	face_sdk__make_version_info (face_sdk__version_info_t **version_info)
	Makes an instance of face_sdk__version_info. More...
void	face_sdk__version_info_free (face_sdk__version_info_t *version_info)
	Destroys face_sdk__version_info object. More...

Detailed Description

Function Documentation

face_sdk__make_version_info()

bool face_sdk__make_version_info

(

face_sdk__version_info_t **

version_info

)

Makes an instance of face_sdk__version_info.

Parameters

[out]

version_info

Version Info object

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_addr()

bool face_sdk__version_info__get_addr	(	const face_sdk__version_info_t *	version_info,
		uint64_t *	addr
	)

Retrieves face_sdk__version_info_t object address * *.

Parameters

[in]	version_info	face_sdk__version_info_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_code_name()

bool face_sdk__version_info__get_code_name	(	const face_sdk__version_info_t *	version_info,
		uint8_t **	string_buffer,
		uint64_t *	string_buffer_len
	)

Retrieves code name of FaceSDK.

Parameters

[in]	version_info	Version Info object
[out]	string_buffer	String containing code name. See text_encoding
[out]	string_buffer_size	Size in bytes of version_info string

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_full_version_string()

bool face_sdk__version_info__get_full_version_string	(	const face_sdk__version_info_t *	version_info,
		uint8_t **	string_buffer,
		uint64_t *	string_buffer_size
	)

Retrieves full version string: "major.minor code_name (git_commit)".

Parameters

[in]	version_info	Version Info object
[out]	string_buffer	String containing version information. See text_encoding
[out]	string_buffer_size	Size in bytes of version_info string

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_git_commit()

bool face_sdk__version_info__get_git_commit	(	const face_sdk__version_info_t *	version_info,
		uint8_t **	string_buffer,
		uint64_t *	string_buffer_len
	)

Retrieves git commit hash of FaceSDK build.

Parameters

[in]	version_info	Version Info object
[out]	string_buffer	String containing git commit. See text_encoding
[out]	string_buffer_size	Size in bytes of version_info string

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_major()

bool face_sdk__version_info__get_major	(	const face_sdk__version_info_t *	version_info,
		uint32_t *	value
	)

Retrieves major version of FaceSDK.

Parameters

[in]	version_info	Version Info object
[out]	value	Major version

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_minor()

bool face_sdk__version_info__get_minor	(	const face_sdk__version_info_t *	version_info,
		uint32_t *	value
	)

Retrieves minor version of FaceSDK.

Parameters

[in]	version_info	Version Info object
[out]	value	Minor version

Returns

true on success, false on failure. See last_error

face_sdk__version_info__get_patch()

bool face_sdk__version_info__get_patch	(	const face_sdk__version_info_t *	version_info,
		uint32_t *	value
	)

Retrieves patch version of FaceSDK.

Parameters

[in]	version_info	Version Info object
[out]	value	Patch version

Returns

true on success, false on failure. See last_error

face_sdk__version_info_free()

void face_sdk__version_info_free

(

face_sdk__version_info_t *

version_info

)

Destroys face_sdk__version_info object.

Parameters

[in]

version_info

Version Info object