bsoncxx/v_noabi/bsoncxx/config/export.hpp

Description

This page documents macros provided by the generated header bsoncxx/v_noabi/bsoncxx/config/export.hpp.

bsoncxx/v_noabi/bsoncxx/config/export.hpp
These macros are provided by export.hpp, NOT by fwd.hpp (where this is documented in source)!
#define	BSONCXX_ABI_EXPORT
	Exports the associated entity as part of the ABI.
#define	BSONCXX_ABI_NO_EXPORT
	Excludes the associated entity from being part of the ABI.
#define	BSONCXX_ABI_CDECL
	Expands to __cdecl when built with MSVC on Windows.
#define	BSONCXX_ABI_EXPORT_CDECL(...)
	Equivalent to BSONCXX_ABI_EXPORT with BSONCXX_ABI_CDECL.
#define	BSONCXX_API   BSONCXX_ABI_EXPORT
	Equivalent to BSONCXX_ABI_EXPORT.
#define	BSONCXX_PRIVATE   inline BSONCXX_ABI_NO_EXPORT
	Equivalent to inline with BSONCXX_ABI_NO_EXPORT.
#define	BSONCXX_DEPRECATED
	Declares the associated entity as deprecated.
#define	BSONCXX_DEPRECATED_EXPORT
	Equivalent to BSONCXX_API and BSONCXX_DEPRECATED.
#define	BSONCXX_DEPRECATED_NO_EXPORT
	Equivalent to BSONCXX_PRIVATE and BSONCXX_DEPRECATED.

Macro Definition Documentation

BSONCXX_ABI_CDECL

#define BSONCXX_ABI_CDECL

Expands to __cdecl when built with MSVC on Windows.

Warning

For internal use only!

BSONCXX_ABI_EXPORT

#define BSONCXX_ABI_EXPORT

Exports the associated entity as part of the ABI.

Warning

For internal use only!

BSONCXX_ABI_EXPORT_CDECL

#define BSONCXX_ABI_EXPORT_CDECL

(

...

)

Value:

BSONCXX_ABI_EXPORT __VA_ARGS__ BSONCXX_ABI_CDECL

Equivalent to BSONCXX_ABI_EXPORT with BSONCXX_ABI_CDECL.

Warning

For internal use only!

BSONCXX_ABI_NO_EXPORT

#define BSONCXX_ABI_NO_EXPORT

Excludes the associated entity from being part of the ABI.

Warning

For internal use only!

BSONCXX_API

#define BSONCXX_API   BSONCXX_ABI_EXPORT

Equivalent to BSONCXX_ABI_EXPORT.

Warning

For internal use only!

Note

This is a symbol visibility control macro, NOT a declaration of public API. Public API vs. private API is determined by the placement of the entity being declared (e.g. in a public header, as a public class member, etc.) or by documentation (e.g. absence of "For internal use only!" warnings). See API and ABI Versioning.

BSONCXX_DEPRECATED

#define BSONCXX_DEPRECATED

Declares the associated entity as deprecated.

Warning

For internal use only!

BSONCXX_DEPRECATED_EXPORT

#define BSONCXX_DEPRECATED_EXPORT

Equivalent to BSONCXX_API and BSONCXX_DEPRECATED.

Warning

For internal use only!

BSONCXX_DEPRECATED_NO_EXPORT

#define BSONCXX_DEPRECATED_NO_EXPORT

Equivalent to BSONCXX_PRIVATE and BSONCXX_DEPRECATED.

Warning

For internal use only!

BSONCXX_PRIVATE

#define BSONCXX_PRIVATE   inline BSONCXX_ABI_NO_EXPORT

Equivalent to inline with BSONCXX_ABI_NO_EXPORT.

Warning

For internal use only!

Note

This is a symbol visibility control macro, NOT a declaration of private API. Public API vs. private API is determined by the placement of the entity being declared (e.g. in a detail header, as a private class member, etc.) or by documentation (e.g. "For internal use only!", absence of documentation, etc.). See API and ABI Versioning.