Yeppp!
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Functions
Library initialization, deinitialization, and version information

Data Structures

struct  YepLibraryVersion
 Contains information about Yeppp! library version. More...
 

Functions

enum YepStatus yepLibrary_Init ()
 Initialized the Yeppp! library. More...
 
enum YepStatus yepLibrary_Release ()
 Deinitialized the Yeppp! library and releases the consumed system resources. More...
 
struct YepLibraryVersionyepLibrary_GetVersion ()
 Returns basic information about the library version. More...
 

Detailed Description


Data Structure Documentation

struct YepLibraryVersion

Contains information about Yeppp! library version.

See Also
yepLibrary_GetVersion

Data Fields

Yep32u major
 The major version. Library releases with the same major versions are guaranteed to be API- and ABI-compatible.
 
Yep32u minor
 The minor version. A change in minor versions indicates addition of new features, and major bug-fixes.
 
Yep32u patchLevel
 The patch level. A version with a higher patch level indicates minor bug-fixes.
 
Yep32u build
 The build number. The build number is unique for the fixed combination of major, minor, and patch-level versions.
 
const char * releaseName
 A UTF-8 string with a human-readable name of this release. May contain non-ASCII characters.
 

Function Documentation

enum YepStatus yepLibrary_Init ( )

Initialized the Yeppp! library.

Return values
YepStatusOkThe library is successfully initialized.
YepStatusSystemErrorAn uncoverable error inside the OS kernel occurred during library initialization.
See Also
yepLibrary_Release
Examples:
CpuCycles.c, CpuInfo.c, Entropy.c, Polynomial.c, and SystemTimer.c.
enum YepStatus yepLibrary_Release ( )

Deinitialized the Yeppp! library and releases the consumed system resources.

Return values
YepStatusOkThe library is successfully initialized.
YepStatusSystemErrorThe library failed to release some of the resources due to a failed call to the OS kernel.
See Also
yepLibrary_Init
Examples:
CpuCycles.c, CpuInfo.c, Entropy.c, Polynomial.c, and SystemTimer.c.
struct YepLibraryVersion* yepLibrary_GetVersion ( )

Returns basic information about the library version.

Note
It is safe to call this function without initializing the library.
Returns
A pointer to a structure describing Yeppp! library version.