Error Handling

Enumerations

enum  arbb_error_t {
  arbb_error_none, arbb_error_invalid_argument, arbb_error_scoping, arbb_error_out_of_bounds,
  arbb_error_arithmetic, arbb_error_bad_alloc, arbb_error_uninitialized_access, arbb_error_internal
}
 

An error code representing the result of a function.

More...

Functions

ARBB_VM_EXPORT const char * arbb_get_error_message (arbb_error_details_t error_details)
 Returns a character string with an informative error message corresponding to error_details.
ARBB_VM_EXPORT arbb_error_t arbb_get_error_code (arbb_error_details_t error_details)
 Returns the error code corresponding to error_details object.
ARBB_VM_EXPORT void arbb_free_error_details (arbb_error_details_t error_details)
 Frees the resources for error_details.

Enumeration Type Documentation

An error code representing the result of a function.

Enumerator:
arbb_error_none 

No error occurred.

arbb_error_invalid_argument 

At least one argument provided to a function was invalid. For example, a null object was provided to a parameter that must not be null.

arbb_error_scoping 

An API operation was attempted in an illegal scope. For example, an attempt to add a control flow operation was made without having a currently defined function.

arbb_error_out_of_bounds 

An attempt to access a container out of bounds was made.

arbb_error_arithmetic 

Arithmetic exception occurred, such as overflow, underflow, or division by 0.

arbb_error_bad_alloc 

Memory allocation failed.

arbb_error_uninitialized_access 

Undefined variable was used.

arbb_error_internal 

Unexpected internal error occurred.

Definition at line 198 of file arbb_vmapi.h.


Function Documentation

ARBB_VM_EXPORT const char* arbb_get_error_message ( arbb_error_details_t  error_details  ) 

Returns a character string with an informative error message corresponding to error_details.

Returns:
Descriptive error message. If a null error details object is passed in, a null pointer is returned.
ARBB_VM_EXPORT arbb_error_t arbb_get_error_code ( arbb_error_details_t  error_details  ) 

Returns the error code corresponding to error_details object.

Returns:
Error code. If a null error details object is passed in, arbb_error_none is returned.
ARBB_VM_EXPORT void arbb_free_error_details ( arbb_error_details_t  error_details  ) 

Frees the resources for error_details.

If error_details is a null object, this function has no effect.

Submit feedback on this help topic

Copyright © 2010, Intel Corporation. All rights reserved.