Internal Associated APIs

The following APIs in ge_api_error_codes.h are internal and not directly called by developers.

  • ErrorNoRegisterar class: error code registration class, for registering specific error codes and their description

    Includes the following member functions:

    • Two constructors:

      ErrorNoRegisterar(uint32_t err, const std::string &desc) noexcept

      ErrorNoRegisterar(const uint32_t err, const char *const desc) noexcept

      err indicates the error code, and desc indicates the error code description.

    • One default destructor:

      ~ErrorNoRegisterar() = default

  • StatusFactory class: single-instance status factory class, for managing registered error codes

    Includes the following member functions:

    • AscendString GetErrDescV2(const uint32_t err), for obtaining the error code description based on the error value (This API is compatible with the ABI and is recommended.)
    • static StatusFactory *Instance(), for returning an instance object of class StatusFactory. It must be unique.
    • void RegisterErrorNo(uint32_t err, const std::string &desc) and void RegisterErrorNo(const uint32_t err, const char *const desc), for registering error codes
    • std::string GetErrDesc(uint32_t err), for obtaining the error code description corresponding to a specific error code