Function: get_recent_err_msg

Applicability

Product

Supported (√/x)

Atlas A3 training products/Atlas A3 inference products

Atlas A2 training products/Atlas A2 inference products

Atlas training products

Atlas inference products

Atlas 200I/500 A2 inference products

Function Usage

Obtains and clears the error messages returned by other failed pyacl API calls in the calling thread.

The err_msg_mode configuration item in the acl.init API determines whether to obtain the process- or thread-level error description. The thread-level error description is obtained by default.

Prototype

  • C Prototype
    1
    const char *aclGetRecentErrMsg()
    
  • Python Function
    1
    msg = acl.get_recent_err_msg()
    

Parameter Description

None.

Return Value Description

Return Value

Description

ret

Int, error code: 0 on success; else, failure.

Restrictions

  • You are advised to make a separate acl.get_recent_err_msg call on each pyacl API call failure to facilitate troubleshooting.
  • If acl.get_recent_err_msg has been called for multiple times in a thread, only the error message string returned by the most recent call is valid. Do not use those returned by the previous calls as this will result in unauthorized memory access.
  • Make a separate acl.get_recent_err_msg call on each pyacl API call failure to avoid error messages from being stacked or lost.