/**
 * @file   FLMRTC.h
 * @brief  FLMRTC - FLAM-Return-Codes
 * @author limes datentechnik gmbh
 * @date   14.01.2016
 * @copyright limes datentechnik gmbh
 **/

/*! @cond PRIVATE */
#ifdef __cplusplus
   extern "C" {
#endif

#ifndef INC_FLMRTC_H
#define INC_FLMRTC_H
/*! @endcond */

/**
 * @defgroup FLMRTC Return codes
 * @brief FLAM Return/Reason codes
 *
 * This chapter contains all FLAM return codes defined by the FL5
 * infrastructure. This internal reason code will be a 32 bit integer
 * value containing a decimal number which is related to a certain error
 * situation.
 *
 * The reason code are useful for program control. Additional the FL5
 * infrastructure provides functionalities to map such a return code in
 * an error message and to obtain a error trace for more information.
 * It depends of the interface you are using how the mapping function
 * and error trace will be provided.
 *
 * A FLAM return code provide the main reason for an error or warning.
 * On high level interfaces (subprogram, command line) the internal FLAM
 * return code is provided as reason code and a additional condition code
 * (0, 4, 8, ...) is set by the application or subprogram. Low level
 * interfaces (byte, record and element API) use the values defined in
 * this chapter as return code.
 *
 * @{
 */
#define FLMRTC_OK    0 /**< @brief Success                                     */
#define FLMRTC_FAT   1 /**< @brief Fatal error (not expected)                  */
#define FLMRTC_SYS   2 /**< @brief System error (sizeof(U32)!=4)               */
#define FLMRTC_HDL   3 /**< @brief Handle error                                */
#define FLMRTC_ITF   4 /**< @brief Call/parameter/interface error              */
#define FLMRTC_NOT   5 /**< @brief Action not possible                         */
#define FLMRTC_ALC   6 /**< @brief Memory allocation failed                    */
#define FLMRTC_LEN   7 /**< @brief Length not valid                            */
#define FLMRTC_CTR   8 /**< @brief Control code not valid                      */
#define FLMRTC_VSN   9 /**< @brief Version not supported                       */
#define FLMRTC_FUC  10 /**< @brief Function not supported                      */
#define FLMRTC_MOD  11 /**< @brief Mode not supported                          */
#define FLMRTC_SUT  12 /**< @brief Suite not supported                         */
#define FLMRTC_CNF  13 /**< @brief Confidential mode not supported             */
#define FLMRTC_INT  14 /**< @brief Integrity mode not supported                */
#define FLMRTC_VRI  15 /**< @brief Verification mode not supported             */
#define FLMRTC_HCS  16 /**< @brief Header check sum not valid                  */
#define FLMRTC_PCS  17 /**< @brief Pot check sum not valid                     */
#define FLMRTC_DCS  18 /**< @brief Data check sum not valid                    */
#define FLMRTC_CHK  19 /**< @brief Check sum not valid                         */
#define FLMRTC_MAC  20 /**< @brief MAC not valid                               */
#define FLMRTC_KTV  21 /**< @brief KTV not valid                               */
#define FLMRTC_SYN  22 /**< @brief Syntax not valid                            */
#define FLMRTC_CNT  23 /**< @brief Amount not valid                            */
#define FLMRTC_EOL  24 /**< @brief End of list (informational)                 */
#define FLMRTC_DEL  25 /**< @brief Delete not successful                       */
#define FLMRTC_TYP  26 /**< @brief Type not valid                              */
#define FLMRTC_RBD  27 /**< @brief Rebuild required (informational)            */
#define FLMRTC_NCG  28 /**< @brief No change happen (informational)            */
#define FLMRTC_STA  29 /**< @brief State not valid                             */
#define FLMRTC_ORI  30 /**< @brief Orientation not supported                   */
#define FLMRTC_SPL  31 /**< @brief Split method not supported                  */
#define FLMRTC_DLM  32 /**< @brief Maximum of records achieved                 */
#define FLMRTC_CMP  33 /**< @brief Error at compression                        */
#define FLMRTC_DCO  34 /**< @brief Error at decompression                      */
#define FLMRTC_HLN  35 /**< @brief Maximal header length achieved              */
#define FLMRTC_DLN  36 /**< @brief Maximal data length achieved                */
#define FLMRTC_FFO  37 /**< @brief Failed to open a FLAMFILE                   */
#define FLMRTC_RCF  38 /**< @brief Record format not supported                 */
#define FLMRTC_FWR  39 /**< @brief Write failed                                */
#define FLMRTC_FRD  40 /**< @brief Read failed                                 */
#define FLMRTC_FGP  41 /**< @brief Determine position failed                   */
#define FLMRTC_FSP  42 /**< @brief Set position failed                         */
#define FLMRTC_EOF  43 /**< @brief End of file (informational)                 */
#define FLMRTC_FFR  44 /**< @brief Rename of FLAMFILE failed                   */
#define FLMRTC_FFD  45 /**< @brief Delete of FLAMFILE failed                   */
#define FLMRTC_FFC  46 /**< @brief Close of FLAMFILE failed                    */
#define FLMRTC_FSK  47 /**< @brief Seek in file failed                         */
#define FLMRTC_FSB  48 /**< @brief Set buffer size failed                      */
#define FLMRTC_FFF  49 /**< @brief FLAMFILE format not supported               */
#define FLMRTC_NFF  50 /**< @brief No FLAMFILE                                 */
#define FLMRTC_FND  51 /**< @brief Not find (informational)                    */
#define FLMRTC_EPY  52 /**< @brief Empty construct (informational)             */
#define FLMRTC_CON  53 /**< @brief Connection error                            */
#define FLMRTC_FID  54 /**< @brief Unsupported FLAM-ID                         */
#define FLMRTC_RPC  55 /**< @brief Remote procedure call failed                */
#define FLMRTC_MTD  56 /**< @brief Method not supported                        */
#define FLMRTC_FOP  57 /**< @brief Failed to open a file                       */
#define FLMRTC_GZP  58 /**< @brief GZIP error                                  */
#define FLMRTC_CHS  59 /**< @brief Char set not supported                      */
#define FLMRTC_AIR  60 /**< @brief Space too small                             */
#define FLMRTC_LOG  61 /**< @brief Logging facility does not work              */
#define FLMRTC_ICV  62 /**< @brief Error from character conversion module      */
#define FLMRTC_HFO  63 /**< @brief Failed to open the hash output file         */
#define FLMRTC_FCL  64 /**< @brief Close of file failed                        */
#define FLMRTC_KME  65 /**< @brief Error in FKME module                        */
#define FLMRTC_CHR  66 /**< @brief Character conversion error                  */
#define FLMRTC_INF  67 /**< @brief Info not supported                          */
#define FLMRTC_BND  68 /**< @brief Band not supported                          */
#define FLMRTC_RFO  69 /**< @brief Open report file failed                     */
#define FLMRTC_SIZ  70 /**< @brief Size invalid                                */
#define FLMRTC_IVC  71 /**< @brief Invalid char                                */
#define FLMRTC_ICC  72 /**< @brief Incomplete char                             */
#define FLMRTC_BOM  73 /**< @brief Error with byte order mark                  */
#define FLMRTC_FMT  74 /**< @brief Format wrong or not supported               */
#define FLMRTC_ACV  75 /**< @brief Auto conversion not possible                */
#define FLMRTC_BZ2  76 /**< @brief BZIP2 error                                 */
#define FLMRTC_ENV  77 /**< @brief Error with environment variable             */
#define FLMRTC_DYL  78 /**< @brief Dynamic load failed                         */
#define FLMRTC_ACS  79 /**< @brief Error from access module                    */
#define FLMRTC_LIM  80 /**< @brief Special condition code, compression limit not reached */
#define FLMRTC_LXZ  81 /**< @brief XZ error                                    */
#define FLMRTC_EXP  82 /**< @brief Expat error                                 */
#define FLMRTC_PAD  83 /**< @brief Whole first block is padding                */
#define FLMRTC_CLP  84 /**< @brief Command line parser failed                  */
#define FLMRTC_MAP  85 /**< @brief Mapping failed                              */
#define FLMRTC_TMP  86 /**< @brief Failed to open a temporary file             */
#define FLMRTC_MBE  87 /**< @brief Wrong magic bytes (magic bytes error)       */
#define FLMRTC_CFF  88 /**< @brief Corrupted or no FLAMFILE                    */
#define FLMRTC_INI  89 /**< @brief Initialization error                        */
#define FLMRTC_PAR  90 /**< @brief Parameter not formatted correctly           */
#define FLMRTC_BIN  91 /**< @brief Binary data detected                        */
#define FLMRTC_EQU  92 /**< @brief From and to are equal                       */
#define FLMRTC_ENC  93 /**< @brief Data are encrypted (key required)           */
#define FLMRTC_KEY  94 /**< @brief Key wrong                                   */
#define FLMRTC_REA  95 /**< @brief Reallocation required                       */
#define FLMRTC_USR  96 /**< @brief Invalid user name                           */
#define FLMRTC_AUH  97 /**< @brief Authentication failed                       */
#define FLMRTC_HSH  98 /**< @brief Hash calculation failed                     */
#define FLMRTC_DIR  99 /**< @brief Processing of one or more files failed      */
#define FLMRTC_HFE 100 /**< @brief Hash file empty                             */
#define FLMRTC_HFR 101 /**< @brief Read of hash/checksum file failed           */
#define FLMRTC_HFN 102 /**< @brief Hash/checksum file name not valid           */
#define FLMRTC_HFF 103 /**< @brief Hash/checksum file not correct formated     */
#define FLMRTC_CTO 104 /**< @brief Failed to open the code table               */
#define FLMRTC_CTF 105 /**< @brief Code table not correct formated             */
#define FLMRTC_ATR 106 /**< @brief Attribute settings not supported            */
#define FLMRTC_OPT 107 /**< @brief Option not supported                        */
#define FLMRTC_IPC 108 /**< @brief Invalid parameter combination               */
#define FLMRTC_IFO 109 /**< @brief Failed to open the info file                */
#define FLMRTC_PRT 110 /**< @brief Protocol not supported                      */
#define FLMRTC_DIF 111 /**< @brief Differences found                           */
#define FLMRTC_TAS 112 /**< @brief Special condition code, try again with ASCII*/
#define FLMRTC_INC 113 /**< @brief Data incomplete                             */
#define FLMRTC_PRC 114 /**< @brief Procedure not supported                     */
#define FLMRTC_KNF 115 /**< @brief Key not found                               */
#define FLMRTC_PGP 116 /**< @brief OpenPGP error                               */
#define FLMRTC_ALG 117 /**< @brief Algorithm not supported                     */
#define FLMRTC_KIA 118 /**< @brief Key inactive                                */
#define FLMRTC_KIV 119 /**< @brief Key invalid                                 */
#define FLMRTC_KXP 120 /**< @brief Key expired                                 */
#define FLMRTC_POS 121 /**< @brief Positioning failed                          */
#define FLMRTC_SEQ 122 /**< @brief Sequence error, incorrect order             */
#define FLMRTC_UPD 123 /**< @brief Update not possible                         */
#define FLMRTC_REG 124 /**< @brief Regular expression error                    */
#define FLMRTC_RNG 125 /**< @brief Value out of range                          */
#define FLMRTC_USG 126 /**< @brief Usage measurement not possible              */
#define FLMRTC_DMY 127 /**< @brief Dummy processing requested, but not possible*/
#define FLMRTC_VFO 128 /**< @brief Failed to open the inverse command file     */
#define FLMRTC_ITN 129 /**< @brief Internal error (may not happen)             */
#define FLMRTC_MFS 130 /**< @brief Micro Focus support failed                  */
#define FLMRTC_STR 131 /**< @brief Dynamic string library error                */
#define FLMRTC_OUL 132 /**< @brief Open of usage log failed                    */
#define FLMRTC_SER 133 /**< @brief Serialization failed                        */
#define FLMRTC_DSR 134 /**< @brief De-serialization failed                     */
#define FLMRTC_PCR 135 /**< @brief Program call (PC) failed                    */
#define FLMRTC_ROW 136 /**< @brief Row specification wrong                     */
#define FLMRTC_RCD 137 /**< @brief Record delimiter not supported              */
#define FLMRTC_EOT 138 /**< @brief End of table (informational)                */
#define FLMRTC_EOM 139 /**< @brief End of member (informational)               */
#define FLMRTC_HMD 140 /**< @brief Have more data (informational)              */
#define FLMRTC_ALN 141 /**< @brief Alignment error                             */
#define FLMRTC_SPC 142 /**< @brief Not enough space                            */
#define FLMRTC_PLS 143 /**< @brief Plausibility error                          */
#define FLMRTC_RST 144 /**< @brief Unexpected remaining rest                   */
#define FLMRTC_LNG 145 /**< @brief Length value too small                      */
#define FLMRTC_VRS 146 /**< @brief Virus found                                 */
#define FLMRTC_CWC 147 /**< @brief Connection was closed                       */
#define FLMRTC_AVS 148 /**< @brief Error from anti virus scanner               */
#define FLMRTC_AUT 149 /**< @brief Authorization failed                        */
#define FLMRTC_CMD 150 /**< @brief Command execution failed                    */
#define FLMRTC_AEX 151 /**< @brief Already exists                              */
#define FLMRTC_FTL 152 /**< @brief Tell offset in file failed                  */
#define FLMRTC_RTL 153 /**< @brief Record too long                             */
#define FLMRTC_RTS 154 /**< @brief Record too short                            */
#define FLMRTC_DFA 155 /**< @brief Dynamic allocation of a file failed         */
#define FLMRTC_FRO 156 /**< @brief Re-open of file failed                      */
#define FLMRTC_NFD 157 /**< @brief No such file or directory                   */
#define FLMRTC_PDN 158 /**< @brief Permission denied                           */
#define FLMRTC_NSL 159 /**< @brief No space left on device                     */
#define FLMRTC_NBS 160 /**< @brief Special condition code, Restart with larger block size required */
#define FLMRTC_CLS 161 /**< @brief Close/end tag/delimiter encountered         */
#define FLMRTC_MIS 162 /**< @brief Missing field definition                    */
#define FLMRTC_EAD 163 /**< @brief Element already deleted                     */
#define FLMRTC_ZST 164 /**< @brief ZSTD error                                  */
#define FLMRTC_CRY 165 /**< @brief Crypto error                                */
#define FLMRTC_PFO 166 /**< @brief Open of side/parameter file failed          */
#define FLMRTC_PFW 167 /**< @brief Write of side/parameter file failed         */
#define FLMRTC_LMM 168 /**< @brief Length mismatch                             */
#define FLMRTC_REC 169 /**< @brief Compile of regular expression failed        */
#define FLMRTC_REV 170 /**< @brief Validation based on regular expression failed*/
#define FLMRTC_RER 171 /**< @brief Replacement based on regular expression failed*/
#define FLMRTC_IGR 172 /**< @brief Ignore record (must be handled)             */
/** @} */

/*! @cond PRIVATE */
#endif /* INC_FLMRTC_H */

#ifdef __cplusplus
   }
#endif
/*! @endcond */

