Error Handling APIs - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
da_status da_handle_print_error_message(da_handle handle)#

Print error information stored in the handle.

Some functions store extra information about errors and this function prints (to standard output) the stored error message(s).

Parameters:

handle[inout] the da_handle structure.

Returns:

da_status. The function returns:

da_status da_datastore_print_error_message(da_datastore store)#

Print error information stored in the store handle.

Print (trace of) error message(s) stored in the handle. Some functions store extra information about errors and this function prints (to standard output) the stored error message(s).

Parameters:

store[inout] the da_datastore structure.

Returns:

da_status. The function returns:

typedef enum da_status_ da_status#

Alias for the da_status_ enum.

enum da_status_#

This enumeration describes all the possible return values from AOCL-DA APIs.

Values:

enumerator da_status_success#

Operation was successful.

enumerator da_status_internal_error#

Unexpected error occurred.

enumerator da_status_memory_error#

Memory could not be allocated.

enumerator da_status_invalid_pointer#

A provided pointer was invalid.

enumerator da_status_invalid_input#

An input parameter had an invalid value.

enumerator da_status_not_implemented#

Feature not implemented.

enumerator da_status_out_of_date#

The data is out of date.

enumerator da_status_wrong_type#

A function called with the wrong data type.

enumerator da_status_overflow#

Numerical overflow detected.

enumerator da_status_invalid_handle_type#

Invalid handle type provided.

enumerator da_status_handle_not_initialized#

Handle was not initialized properly or is corrupted.

enumerator da_status_store_not_initialized#

Store was not initialized properly or is corrupted.

enumerator da_status_invalid_option#

Invalid option detected.

enumerator da_status_incompatible_options#

Incompatible option detected.

enumerator da_status_operation_failed#

Signal that an internal operation failed (could not solve a hard linear system as part of a larger process).

enumerator da_status_invalid_leading_dimension#

Invalid leading dimension for a 2D array.

enumerator da_status_negative_data#

The function expected positive data but a negative entry was found.

enumerator da_status_invalid_array_dimension#

The size of an array was too small.

enumerator da_status_unknown_query#

The result queried cannot be found in the handle.

enumerator da_status_incorrect_output#

Wrong output.

enumerator da_status_no_data#

No data was found.

enumerator da_status_maxit#

Iteration limit reached without converging.

enumerator da_status_maxtime#

Time limit reached without converging.

enumerator da_status_numerical_difficulties#

Numerical difficulties.

enumerator da_status_bad_derivatives#

Likely errors are detected in the user-supplied derivatives.

enumerator da_status_arch_not_supported#

The architecture is not supported.

enumerator da_status_file_reading_error#

An error occurred when reading a CSV file.

enumerator da_status_parsing_error#

An error occurred when parsing a CSV file into numeric data.

enumerator da_status_missing_data#

The array returned from reading a CSV file contains missing data.

enumerator da_status_option_not_found#

Option not found.

enumerator da_status_option_locked#

Cannot change option value at this point.

enumerator da_status_option_wrong_type#

Wrong option type passed.

enumerator da_status_option_invalid_bounds#

Option value is out-of-bounds.

enumerator da_status_option_invalid_value#

Cannot set option to an invalid value.

enumerator da_status_optimization_usrstop#

User requested to stop optimization process.

enumerator da_status_optimization_infeasible#

The problem is infeasible, the bounds describe an empty domain.

enumerator da_status_optimization_empty_space#

No variables are defined in the problem.

enumerator da_status_missing_block#

The store is missing a block, the requested operation cannot be performed.

enumerator da_status_full_extraction#

No selection was defined, the full store is being extracted.