Botan 3.7.1
Crypto and TLS for C&
api.h File Reference

Public Header. More...

#include <botan/build.h>

Go to the source code of this file.

Macros

#define BOTAN_DEPRECATED(msg)
 
#define BOTAN_DEPRECATED_API(msg)
 
#define BOTAN_DEPRECATED_HEADER(hdr)
 
#define BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS
 
#define BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE
 
#define BOTAN_DIAGNOSTIC_POP
 
#define BOTAN_DIAGNOSTIC_PUSH
 
#define BOTAN_FUTURE_INTERNAL_HEADER(hdr)
 
#define BOTAN_FUZZER_API
 
#define BOTAN_PUBLIC_API(maj, min)
 
#define BOTAN_TEST_API   BOTAN_DLL
 
#define BOTAN_UNSTABLE_API   BOTAN_DLL
 

Detailed Description

Public Header.

Definition in file api.h.

Macro Definition Documentation

◆ BOTAN_DEPRECATED

#define BOTAN_DEPRECATED ( msg)
Value:
[[deprecated(msg)]]

Definition at line 59 of file api.h.

◆ BOTAN_DEPRECATED_API

#define BOTAN_DEPRECATED_API ( msg)
Value:
#define BOTAN_DEPRECATED(msg)
Definition api.h:59
#define BOTAN_DLL
Definition build.h:85

Used to annotate API exports which are public, but are now deprecated and which will be removed in a future major release.

Definition at line 25 of file api.h.

◆ BOTAN_DEPRECATED_HEADER

#define BOTAN_DEPRECATED_HEADER ( hdr)

Definition at line 80 of file api.h.

◆ BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS

#define BOTAN_DIAGNOSTIC_IGNORE_DEPRECATED_DECLARATIONS

◆ BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE

#define BOTAN_DIAGNOSTIC_IGNORE_INHERITED_VIA_DOMINANCE

Definition at line 107 of file api.h.

◆ BOTAN_DIAGNOSTIC_POP

#define BOTAN_DIAGNOSTIC_POP

◆ BOTAN_DIAGNOSTIC_PUSH

#define BOTAN_DIAGNOSTIC_PUSH

◆ BOTAN_FUTURE_INTERNAL_HEADER

#define BOTAN_FUTURE_INTERNAL_HEADER ( hdr)

Definition at line 84 of file api.h.

◆ BOTAN_FUZZER_API

#define BOTAN_FUZZER_API

Used to annotate API exports which are exported but only for the purposes of fuzzing. They should not be used by applications and may be removed or changed without notice.

They are only exported if the fuzzers are being built

Definition at line 51 of file api.h.

◆ BOTAN_PUBLIC_API

#define BOTAN_PUBLIC_API ( maj,
min )
Value:

Used to annotate API exports which are public and supported. These APIs will not be broken/removed unless strictly required for functionality or security, and only in new major versions.

Parameters
majThe major version this public API was released in
minThe minor version this public API was released in

Definition at line 19 of file api.h.

◆ BOTAN_TEST_API

#define BOTAN_TEST_API   BOTAN_DLL

Used to annotate API exports which are exported but only for the purposes of testing. They should not be used by applications and may be removed or changed without notice.

Definition at line 39 of file api.h.

◆ BOTAN_UNSTABLE_API

#define BOTAN_UNSTABLE_API   BOTAN_DLL

Used to annotate API exports which are public and can be used by applications if needed, but which are intentionally not documented, and which may change incompatibly in a future major version.

Definition at line 32 of file api.h.