mirror of
https://github.com/lux-tel/libsession-util.git
synced 2026-10-30 20:25:11 +00:00
Sean Darcy
55671b3dda
Every header in the `include/session/config` directory is now watched
for patterns matching `/// API:` which will be used to populated a web
docs page
41 lines
1000 B
C
41 lines
1000 B
C
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "../export.h"
|
|
|
|
enum config_error {
|
|
/// Value returned for no error
|
|
SESSION_ERR_NONE = 0,
|
|
/// Error indicating that initialization failed because the dumped data being loaded is invalid.
|
|
SESSION_ERR_INVALID_DUMP = 1,
|
|
/// Error indicated a bad value, e.g. if trying to set something invalid in a config field.
|
|
SESSION_ERR_BAD_VALUE = 2,
|
|
};
|
|
|
|
/// API: error/config_errstr
|
|
///
|
|
/// Returns a generic string for a given integer error code as returned by some functions. Depending
|
|
/// on the call, a more details error string may be available in the config_object's `last_error`
|
|
/// field.
|
|
///
|
|
/// Declaration:
|
|
/// ```cpp
|
|
/// CONST CHAR* config_errstr(
|
|
/// [in] int err
|
|
/// );
|
|
/// ```
|
|
///
|
|
/// Inputs:
|
|
/// - `err` -- [in] Integer of the error code
|
|
///
|
|
/// Outputs:
|
|
/// - `const char*` -- text of the error string
|
|
LIBSESSION_EXPORT const char* config_errstr(int err);
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|