error_in_list(_c)
status.i4.v = error_in_list(overall_status.i4.r, list_length.i4.r,
list_errors.i2a.r [,num_first.i4.r])
status.i4.v = error_in_list_c(overall_status.i4.v, list_length.i4.v,
list_errors.i2a.r [,num_first.i4.r])
This routine extracts the first error from a list of errors if the
value of "overall_status" is positive. Otherwise, the value of
"overall_status" is returned.
overall_status overall status value returned by the call that
filled the 'list_errs' array
list_length number of errors in the list
list_errors list of errors
[num_first] number of first error encountered in list (A value
of zero is returned if no errors are found in the
list or if the overall status is returned.)
(starts at 1)
This function returns status values as follows:
OK no errors present
otherwise overall status or first error value
This function requires the following include files:
cnsparam_h, cbslib_h
Related functions:
error_init(_c), error_display(_c), error_printf_c, error_message(_c),
error_mprintf_c, error_colored_message_c, error_cmprintf_c,
error_erase, error_is_occluded, dio_extract_read_list_status_c,
dio_extract_set_list_status_c, intro_error
C/C++ usage:
short list_errors[LIST_LENGTH];
int status;
int overall_status;
int list_length = LIST_LENGTH;
int num_first;
status = error_in_list_c(overall_status,list_length,list_errors,
&num_first);