BSLConfig.h File Reference

Compile-time static configuration for the BSL. More...

#include <stdlib.h>

Include dependency graph for BSLConfig.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	BSL_VERSION   "1.1.1"
	Compile-time library version based on SemVer-2.0.0 conventions.
#define	BSL_VERSION_MAJOR   1
	Compile-time major version number.
#define	BSL_VERSION_MINOR   1
	Compile-time minor version number.
#define	BSL_VERSION_PATCH   1
	Compile-time patch version number.
#define	BSL_LOG_PLAINTEXT_ENABLE   0
	Control whether plaintext data debug logs are made.
#define	BSL_REQUIRE_CHECK
	This annotation on a function requires the caller to capture and inspect the return value.

Functions
const char *	bsl_version (void)
	Run-time library version based on SemVer-2.0.0 conventions.

Detailed Description

Compile-time static configuration for the BSL.

Macro Definition Documentation

BSL_LOG_PLAINTEXT_ENABLE

#define BSL_LOG_PLAINTEXT_ENABLE   0

Control whether plaintext data debug logs are made.

Warning

This should not be enabled for production.

BSL_REQUIRE_CHECK

#define BSL_REQUIRE_CHECK

This annotation on a function requires the caller to capture and inspect the return value.

BSL_VERSION

#define BSL_VERSION   "1.1.1"

Compile-time library version based on SemVer-2.0.0 conventions.

See also

Use bsl_version() to get run-time version.

BSL_VERSION_MAJOR

#define BSL_VERSION_MAJOR   1

Compile-time major version number.

BSL_VERSION_MINOR

#define BSL_VERSION_MINOR   1

Compile-time minor version number.

BSL_VERSION_PATCH

#define BSL_VERSION_PATCH   1

Compile-time patch version number.

Function Documentation

bsl_version()

const char * bsl_version

(

void

)

Run-time library version based on SemVer-2.0.0 conventions.

Note

This may be different than BSL_VERSION if using dynamic linking.

Returns

The text form of the library version linked at runtime.

References BSL_VERSION.