ikm_retval.h

Go to the documentation of this file.

#ifndef IKM_RETVAL_H
#define IKM_RETVAL_H

#ifdef __cplusplus
extern "C" {
#endif

#include "iqr_api.h"

typedef enum {
    IKM_OK                  = 0,

    // -----------------------------------------------------------------------------------------------------------------------------
    // General error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IKM_ENULLPTR            = -1001,

    IKM_ENOMEM              = -1002,

    IKM_ENOTINIT            = -1003,

    IKM_EINVBUFSIZE         = -1004,

    IKM_EBADVALUE           = -1005,

    IKM_EOUTOFRANGE         = -1006,

    IKM_EVALUENOTSUPP       = -1007,

    IKM_EINVOBJECT          = -1008,

    IKM_EINVCALLBACKS       = -1009,

    IKM_ENOTREGISTERED      = -1010,

    IKM_EINVDATA            = -1011,

    IKM_EINVPTR             = -1012,

    IKM_EPTROVERLAP         = -1013,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Algorithm error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IKM_EINVALGOSTATE       = -2001,

    IKM_EINVHASHALGO        = -2002,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Key error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IKM_EINVPUBLICKEY       = -3001,

    IKM_EINVPRIVATEKEY      = -3002,

    IKM_EKEYPAIRMISMATCH    = -3004,

    IKM_EINVSIGNATURE       = -3006,

    IKM_EKEYDEPLETED        = -3007,

    // -----------------------------------------------------------------------------------------------------------------------------
    // Random Number Generator error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IKM_ENOTSEEDED          = -4001,

    IKM_ERESEED             = -4002,

    // -----------------------------------------------------------------------------------------------------------------------------
    // File IO error values.
    // -----------------------------------------------------------------------------------------------------------------------------

    IKM_EIOFAILURE          = -7001,

    IKM_EINVFILEPATH        = -7002,
} ikm_retval;

// ---------------------------------------------------------------------------------------------------------------------------------
// Helper functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
const char *ikm_StrError(ikm_retval ret);

#ifdef __cplusplus
}
#endif

#endif /* IKM_RETVAL_H */