atobase  3.2.0
ATOMAS atobase
SoftwareInfo

The global software information. More...

Functions

ATO_EXPORT int ato_si_set (const char *organisation, const char *product, const char *version, const char *timestamp, const char *source, const char *hash)
 Set up the application information. More...
 
ATO_EXPORT const char * ato_si_organisation (void)
 Return the organisation name owning the application. More...
 
ATO_EXPORT const char * ato_si_product (void)
 Return the product name. More...
 
ATO_EXPORT const char * ato_si_version (void)
 Return the version. More...
 
ATO_EXPORT const char * ato_si_timestamp (void)
 Return the timestamp of the last build of the application. More...
 
ATO_EXPORT const char * ato_si_source (void)
 Return the source details of the last commit of the application - e.g. More...
 
ATO_EXPORT const char * ato_si_hash (void)
 Return the commit details of the last commit of the application - e.g. More...
 
ATO_EXPORT const char * ato_si_info (void)
 Return everything as | delimited. More...
 

Detailed Description

The global software information.

Provides global details of the application.

Function Documentation

◆ ato_si_set()

ATO_EXPORT int ato_si_set ( const char *  organisation,
const char *  product,
const char *  version,
const char *  timestamp,
const char *  source,
const char *  hash 
)

Set up the application information.

Parameters
organisationOrganisation name or individual name.
productName of the application.
versionVersion of the application.
timestampThe timestamp of the last build for the application
sourceof the last source code commit - e.g. git repo name
hashof the last source code commit - e.g. git sha1
Returns
ATO_ERR_OK if ok

◆ ato_si_organisation()

ATO_EXPORT const char* ato_si_organisation ( void  )

Return the organisation name owning the application.

Returns
organisation name

◆ ato_si_product()

ATO_EXPORT const char* ato_si_product ( void  )

Return the product name.

Returns
product name

◆ ato_si_version()

ATO_EXPORT const char* ato_si_version ( void  )

Return the version.

Returns
version

◆ ato_si_timestamp()

ATO_EXPORT const char* ato_si_timestamp ( void  )

Return the timestamp of the last build of the application.

Returns
build timestamp

◆ ato_si_source()

ATO_EXPORT const char* ato_si_source ( void  )

Return the source details of the last commit of the application - e.g.

git repo.

Returns
commit source

◆ ato_si_hash()

ATO_EXPORT const char* ato_si_hash ( void  )

Return the commit details of the last commit of the application - e.g.

git sha1.

Returns
commit hash

◆ ato_si_info()

ATO_EXPORT const char* ato_si_info ( void  )

Return everything as | delimited.

Returns
all info