include/Zycore/Status.h

       Generated automatically by Doxygen for Zycore from the source code.

Zycore                                           Version 1.5.2.0                      include/Zycore/Status.h(3)

       Status code definitions and check macros.

#defineZYAN_CHECK(status)Value:.PP
           do \
           { \
               const ZyanStatus status_047620348 = (status); \
               if (!ZYAN_SUCCESS(status_047620348)) \
               { \
                   return status_047620348; \
               } \
           } while (0)
       Checks if a zyan operation was successful and returns with the status-code, if not.

       Parametersstatus The zyan status-code to check.

   #defineZYAN_FAILED(status)((status)&0x80000000u)
       Checks if a zyan operation failed.

       Parametersstatus The zyan status-code to check.

       Returns
           ZYAN_TRUE, if the operation failed or ZYAN_FALSE, if not.

   #defineZYAN_MAKE_STATUS(error,module,code)(ZyanStatus)((((error)&0x01u)<<31u)|(((module)&0x7FFu)<<20u)|((code)&0xFFFFFu))
       Defines a zyan status code.

       Parameterserror 1, if the status code signals an error or 0, if not.
           module The module id.
           code The actual code.

       Returns
           The zyan status code.

   #defineZYAN_MODULE_ARGPARSE0x003u
       The zycore arg-parse submodule id.

   #defineZYAN_MODULE_USER0x3FFu
       The base module id for user-defined status codes.

   #defineZYAN_MODULE_ZYCORE0x001u
       The zycore generic module id.

   #defineZYAN_STATUS_ACCESS_DENIEDZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x06u)
       Insufficient privileges to perform the requested operation.

   #defineZYAN_STATUS_ARG_MISSES_VALUEZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ARGPARSE,0x03u)
       An argument that expected a value misses its value.

   #defineZYAN_STATUS_ARG_NOT_UNDERSTOODZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ARGPARSE,0x00u)
       Argument was not expected.

   #defineZYAN_STATUS_BAD_SYSTEMCALLZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x0Bu)
       An unknown error occurred during a system function call.

   #defineZYAN_STATUS_CODE(status)((status)&0xFFFFFu)
       Returns the code of a zyan status-code.

       Parametersstatus The zyan status-code.

       Returns
           The code of the zyan status-code.

   #defineZYAN_STATUS_FAILEDZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x01u)
       The operation failed with an generic error.

   #defineZYAN_STATUS_FALSEZYAN_MAKE_STATUS(0u,ZYAN_MODULE_ZYCORE,0x03u)
       The operation completed successfully and returned ZYAN_FALSE.

   #defineZYAN_STATUS_INSUFFICIENT_BUFFER_SIZEZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x09u)
       A buffer passed to a function was too small to complete the requested operation.

   #defineZYAN_STATUS_INVALID_ARGUMENTZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x04u)
       An invalid argument was passed to a function.

   #defineZYAN_STATUS_INVALID_OPERATIONZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x05u)
       An attempt was made to perform an invalid operation.

   #defineZYAN_STATUS_MISSING_DEPENDENCYZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x0Du)
       A dependency library was not found or does have an unexpected version number or feature-set.

   #defineZYAN_STATUS_MODULE(status)(((status)>>20)&0x7FFu)
       Returns the module id of a zyan status-code.

       Parametersstatus The zyan status-code.

       Returns
           The module id of the zyan status-code.

   #defineZYAN_STATUS_NOT_ENOUGH_MEMORYZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x0Au)
       Insufficient memory to perform the operation.

   #defineZYAN_STATUS_NOT_FOUNDZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x07u)
       The requested entity was not found.

   #defineZYAN_STATUS_OUT_OF_RANGEZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x08u)
       An index passed to a function was out of bounds.

   #defineZYAN_STATUS_OUT_OF_RESOURCESZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ZYCORE,0x0Cu)
       The process ran out of resources while performing an operation.

   #defineZYAN_STATUS_REQUIRED_ARG_MISSINGZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ARGPARSE,0x04u)
       A required argument is missing.

   #defineZYAN_STATUS_SUCCESSZYAN_MAKE_STATUS(0u,ZYAN_MODULE_ZYCORE,0x00u)
       The operation completed successfully.

   #defineZYAN_STATUS_TOO_FEW_ARGSZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ARGPARSE,0x01u)
       Too few arguments were provided.

   #defineZYAN_STATUS_TOO_MANY_ARGSZYAN_MAKE_STATUS(1u,ZYAN_MODULE_ARGPARSE,0x02u)
       Too many arguments were provided.

   #defineZYAN_STATUS_TRUEZYAN_MAKE_STATUS(0u,ZYAN_MODULE_ZYCORE,0x02u)
       The operation completed successfully and returned ZYAN_TRUE.

   #defineZYAN_SUCCESS(status)(!((status)&0x80000000u))
       Checks if a zyan operation was successful.

       Parametersstatus The zyan status-code to check.

       Returns
           ZYAN_TRUE, if the operation succeeded or ZYAN_FALSE, if not.

       include/Zycore/Status.h

       #include <Zycore/Types.h>

   Macros
       #define ZYAN_MAKE_STATUS(error,  module,  code)       (ZyanStatus)((((error) & 0x01u) << 31u) |
           (((module) & 0x7FFu) << 20u) | ((code) & 0xFFFFFu))
       #define ZYAN_SUCCESS(status)       (!((status) & 0x80000000u))
       #define ZYAN_FAILED(status)       ((status) & 0x80000000u)
       #define ZYAN_CHECK(status)
       #define ZYAN_STATUS_MODULE(status)       (((status) >> 20) & 0x7FFu)
       #define ZYAN_STATUS_CODE(status)       ((status) & 0xFFFFFu)
       #define ZYAN_MODULE_ZYCORE   0x001u
       #define ZYAN_MODULE_ARGPARSE   0x003u
       #define ZYAN_MODULE_USER   0x3FFu
       #define ZYAN_STATUS_SUCCESSZYAN_MAKE_STATUS(0u, ZYAN_MODULE_ZYCORE, 0x00u)
       #define ZYAN_STATUS_FAILEDZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x01u)
       #define ZYAN_STATUS_TRUEZYAN_MAKE_STATUS(0u, ZYAN_MODULE_ZYCORE, 0x02u)
       #define ZYAN_STATUS_FALSEZYAN_MAKE_STATUS(0u, ZYAN_MODULE_ZYCORE, 0x03u)
       #define ZYAN_STATUS_INVALID_ARGUMENTZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x04u)
       #define ZYAN_STATUS_INVALID_OPERATIONZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x05u)
       #define ZYAN_STATUS_ACCESS_DENIEDZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x06u)
       #define ZYAN_STATUS_NOT_FOUNDZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x07u)
       #define ZYAN_STATUS_OUT_OF_RANGEZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x08u)
       #define ZYAN_STATUS_INSUFFICIENT_BUFFER_SIZEZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x09u)
       #define ZYAN_STATUS_NOT_ENOUGH_MEMORYZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x0Au)
       #define ZYAN_STATUS_BAD_SYSTEMCALLZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x0Bu)
       #define ZYAN_STATUS_OUT_OF_RESOURCESZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x0Cu)
       #define ZYAN_STATUS_MISSING_DEPENDENCYZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ZYCORE, 0x0Du)
       #define ZYAN_STATUS_ARG_NOT_UNDERSTOODZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ARGPARSE, 0x00u)
       #define ZYAN_STATUS_TOO_FEW_ARGSZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ARGPARSE, 0x01u)
       #define ZYAN_STATUS_TOO_MANY_ARGSZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ARGPARSE, 0x02u)
       #define ZYAN_STATUS_ARG_MISSES_VALUEZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ARGPARSE, 0x03u)
       #define ZYAN_STATUS_REQUIRED_ARG_MISSINGZYAN_MAKE_STATUS(1u, ZYAN_MODULE_ARGPARSE, 0x04u)

   Typedefs
       typedef ZyanU32 ZyanStatus

typedefZyanU32ZyanStatus
       Defines the ZyanStatus data type.