| ret_code (1H) | UDF PROGRAMMERS MANUAL | ret_code (1H) |
|---|
SYNOPSIS #include "ret_code.h"
DESCRIPTION This include file holds the defines for the status states output from the UDF kernel code. The list of the status states, the associated status value, and a brief description are given in the table below. Also given in the source routine of the status if limited to a single routine. The listed status values are only those used with the UDF kernel.
STATUS DEFINITIONS
| ERROR | VALUE | ROUTINE | CAUSE |
|---|---|---|---|
| EOF STATUS | 0 | ir_position_real_time ir_read_header start_image |
EOF returned on read |
| ALL_OKAY | 1 | ALL | Successful completion of a routine |
| DREC_NO_SENSOR | 2 | read_drec | Requested sensor was not in the current data record |
| DREC_EOF_NO_SENSOR | 3 | ir_new_data_record | Real Time EOF on forward and no sensor data |
| DREC_EOF_SENSOR | 6 | ir_new_data_record ir_new_header_record |
Real Time EOF on forward and returned sensor data |
| LOS STATUS | 9 | ir_new_data_record ir_new_header_record ir_position_real_time read_drec ir_read_header |
Indicates Loss of Signal in realtime applications |
| NEXT_FILE_STATUS | 12 | ir_position_real_time read_drec ir_read_header |
EOF with data continuing in next file |
| FILE_BACK_UP | 15 | - | Internal only, not a returned status |
| TIME_NOT_FOUND | 18 | ToThisTime | Requested time not found in file |
| RTIME_BAD_SRC | -1 | ir_realtime_data_files | Bad UDF data key used in RealTime mode |
| PBACK_BAD_SRC | -2 | ir_playback_data_files | Bad UDF data key used in PlayBack mode |
| LOCATE_NOT_FOUND | -3 | ir_locate_ex | Probably attepmted UDF access and UDF not open |
| LOCATE_EX_MALLOC | -4 | ir_locate_ex | Malloc error in setting up experiment_info structure |
| LOCATE_PTR_MALLOC | -5 | ir_locate_ex | Malloc error in setting up ptr_rec structure |
| LOCATE_EX_REALLOC | -6 | ir_locate_ex | Realloc error in enlarging experiment_info structure |
| OPEN_EX_MALLOC | -7 | ir_file_setup | Identical to status LOCATE_EX_MALLOC |
| OPEN_PTR_MALLOC | -8 | ir_file_setup | Identical to status LOCATE_PTR_MALLOC |
| OPEN_EX_REALLOC | -9 | ir_file_setup | Identical to status LOCATE_EX_REALLOC |
| RTIME_NO_HEADER | -10 | ir_realtime_data_files | Requested RealTime UDF header file not here |
| RTIME_NO_DATA | -11 | ir_realtime_data_files | Requested Real Time UDF data file not here |
| RTIME_NO_VIDF | -12 | ir_realtime_data_files | Requested Real Time VIDF file not found |
| ALL_FLAG_MALLOC | -13 | ir_file_setup | Malloc error in setting up sensor flag array |
| ALLOC_HDR_READ_ERROR | -14 | ir_alloc_exp_once | Error on reading UDF header file |
| ALLOC_HDR_MALLOC | -15 | ir_alloc_exp_once | Malloc error in setting up header memory buffer |
| ALLOC_HDR_REALLOC | -16 | ir_alloc_exp_once | Realloc error when increasing header memory buffer |
| CAL_DATA_MALLOC | -17 | ir_convert_sensor_data ir_convert_sweep_data |
Malloc error in setting up ancillary data memory buffer |
| PARTIAL_READ | -18 | ir_new_data_record ir_read_header |
Partial record in header or data file |
| SEL_SEN_NOT_FOUND | -19 | select_sensor | Non ALL_OKAY received from locate_ex routine |
| TIME_OFF_MALLOC | -20 | ir_alloc_exp_once | Malloc error in setting up time offset array |
| SCOM_TBL_MALLOC | -21 | ir_sensor_combo | Malloc error in setting up table comparison array |
| SCOM_INDEX_MALLOC | -22 | ir_sensor_combo | Malloc error in setting up sensor index array |
| SCOM_SEN_PTR_MALLOC | -23 | ir_sensor_combo | Malloc error setting up sensor combination arrays |
| SCOM_PTR_MALLOC | -24 | ir_sensor_combo | Malloc error in setting up sensor offset arrays |
| SCOM_IDF_NOT_FOUND | -25 | ir_sensor_combo | Non ALL_OKAY received from locate_ex routine |
| SCOM_IDF_MANY_BYTES | -26 | ir_sensor_combo | Requested more VIDF array elements than exists |
| SCOM_IDF_TBL_NUM | -27 | ir_sensor_combo | Requested a non-existant VIDF table |
| SCOM_IDF_CON_NUM | -28 | ir_sensor_combo | Requested a non-existant VIDF constant |
| SCOM_IDF_NO_ENTRY | -29 | ir_sensor_combo | Requested a non-existant VIDF field |
| CCOM_MATCH_MALLOC | -30 | ir_count_combo | Malloc error in setting up table comparison array |
| CONV_MODE_MISMATCH | -32 | ir_convert_mode_data | Processing raw mode data with non-mode based table |
| GET_ACTION_MALLOC | -33 | ir_get_critical_info | Malloc error in setting up critical action array |
| POS_NOT_FOUND | -34 | file_pos FilePosRec |
No ALL_OKAY from locate_ex routine |
| FILE_POS_MODE | -35 | file_pos FilePosRec |
No ALL_OKAY select_sensor routine |
| POS_DATA_READ_ERROR | -36 | file_pos FilePosRec |
UDF read error in UDF data file |
| POS_HDR_READ_ERROR | -37 | file_pos FilePosRec |
UDF read error in UDF header file |
| POS_HDR_MALLOC | -38 | file_pos FilePosRec |
Malloc error in setting up header record memory buffer |
| POS_HDR_REALLOC | -39 | file_pos FilePosRec |
Realloc error in increasing header record memory buffer |
| PBACK_LOS | -40 | file_pos FilePosRec ir_fine_search |
RealTime Loss of Signal (LOS) |
| PBACK_NEXT_FILE | -41 | file_pos FilePosRec ir_fine_search |
RealTime file closed, open next file |
| RHDR_READ_ERROR | -42 | ir_read_header | Error on reading UDF header file |
| RHDR_HDR_MALLOC | -43 | ir_read_header | Malloc error in setting up header memory buffer |
| RHDR_HDR_REALLOC | -44 | ir_read_header | Realloc error in increasing header memory buffer |
| FILL_HEADER | -45 | ir_read_header | RealTime data usage error |
| DREC_NOT_FOUND | -46 | read_drec | Non ALL_OKAY received from locate_ex routine |
| CONV_CAL_MALLOC | -47 | ir_convert_cal_data | Malloc error setting up temporary Anc Data array |
| DREC_NO_FILES | -48 | read_drec | UDF Header or Data file not open |
| DREC_READ_ERROR | -49 | ir_new_data_record | UDF Data record read error |
| DREC_HDR_READ_ERROR | -50 | read_drec | Error on reading UDF header file |
| DREC_HDR_MALLOC | -51 | ir_new_header_record | Malloc error in setting up header memory buffer |
| DREC_HDR_REALLOC | -52 | ir_new_header_record | Realloc error in increasing header memory buffer |
| RESET_MODE_MALLOC | -53 | ir_check_dependent_on_header | Malloc error in setting up mode array |
| RESET_MODE_REALLOC | -54 | ir_check_dependent_on_header | Realloc error in increasing mode array |
| RESET_NOT_FOUND | -55 | reset_experiment_info | Non ALL_OKAY received from locate_ex routine |
| RESET_DATA_MALLOC | -56 | ir_check_dependent_on_header | Malloc error in setting up data array |
| RESET_DATA_REALLOC | -57 | ir_check_dependent_on_header | Realloc error in increasing data array |
| RESET_ANGLE_MALLOC | -58 | ir_check_dependent_on_header | Malloc error in setting up phase array |
| RESET_ANGLE_REALLOC | -59 | ir_check_dependent_on_header | Realloc error in increasing phase array size |
| ALLOC_EV_MALLOC | -60 | ir_alloc_swp_data | Malloc error in setting up scan array |
| ALLOC_EV_MALLOC | -61 | ir_alloc_swp_data | Realloc error in increasing scan array |
| CRIT_TBL_NOT_FOUND | -62 | ir_check_critical_status | Requested table not found |
| CONST_ANG_MALLOC | -63 | ir_get_constants | Malloc error in setting up phase angle offset constant array |
| CONST_TEMP_MALLOC | -64 | ir_get_constants | Malloc error in setting up constant id temp array |
| CNVT_NOT_FOUND | -65 | convert_to_units | Non ALL_OKAY received from locate_ex routine |
| TBL_MISC_MALLOC | -66 | ir_get_tbl_info | Malloc error in setting up table info array |
| TBL_MALLOC | -67 | ir_get_tbl_info | Malloc error in setting up table arrays |
| TBL_IDF_NOT_FOUND | -68 | ir_get_tbl_info | IDF_NOT_FOUND returned from read_idf |
| TBL_IDF_MANY_BYTES | -69 | ir_get_tbl_info | IDF_MANY_BYTES received from read_idf |
| TBL_IDF_TBL_NUM | -70 | ir_get_tbl_info | IDF_TBL_NUM received from read_idf |
| TBL_IDF_CON_NUM | -71 | ir_get_tbl_info | IDF_CON_NUM received from read_idf |
| TBL_IDF_NO_ENTRY | -72 | ir_get_tbl_info | IDF_NO_ENTRY received from read_idf |
| IDF_NOT_FOUND | -73 | read_idf | Non ALL_OKAY received from locate_ex routine |
| IDF_MANY_BYTES | -74 | ir_read_idf_memory ir_read_idf_disk |
Requested more VIDF array elements than exists |
| IDF_TBL_NUM | -75 | ir_read_idf_memory ir_read_idf_disk |
Requested a non-existant VIDF table |
| IDF_CON_NUM | -76 | ir_read_idf_memory ir_read_idf_disk |
Requested a non-existant VIDF constant |
| IDF_NO_ENTRY | -77 | ir_read_idf_memory ir_read_idf_disk |
Requested a non-existant VIDF field |
| SEN_IDF_NOT_FOUND | -78 | ir_get_sensor_tables | IDF_NOT_FOUND returned from read_idf |
| SEN_IDF_MANY_BYTES | -79 | ir_get_sensor_tables | IDF_MANY_BYTES received from read_idf |
| SEN_IDF_TBL_NUM | -80 | ir_get_sensor_tables | IDF_TBL_NUM received from read_idf |
| SEN_IDF_CON_NUM | -81 | ir_get_sensor_tables | IDF_CON_NUM received from read_idf |
| SEN_IDF_NO_ENTRY | -82 | ir_get_sensor_tables | IDF_NO_ENTRY received from read_idf |
| ONCE_IDF_NOT_FOUND | -83 | ir_read_idf_once | IDF_NOT_FOUND returned from read_idf |
| ONCE_IDF_MANY_BYTES | -84 | ir_read_idf_once | IDF_MANY_BYTES received from read_idf |
| ONCE_IDF_TBL_NUM | -85 | ir_read_idf_once | IDF_TBL_NUM received from read_idf |
| ONCE_IDF_CON_NUM | -86 | ir_read_idf_once | IDF_CON_NUM received from read_idf |
| ONCE_IDF_NO_ENTRY | -87 | ir_read_idf_once | IDF_NO_ENTRY received from read_idf |
| ONCE_DATA_MALLOC | -88 | ir_read_idf_once | Malloc error in setting up table info memory area |
| MODE_TBL_SZ_IDF_NOT_FOUND | -97 | ir_mode_tbl_sz | IDF_NOT_FOUND returned from read_idf |
| MODE_TBL_SZ_IDF_MANY_BYTES | -98 | ir_mode_tbl_sz | IDF_MANY_BYTES received from read_idf |
| MODE_TBL_SZ_IDF_TBL_NUM | -99 | ir_mode_tbl_sz | IDF_TBL_NUM received from read_idf |
| MODE_TBL_SZ_IDF_CON_NUM | -100 | ir_mode_tbl_sz | IDF_CON_NUM received from read_idf |
| MODE_TBL_SZ_IDF_NO_ENTRY | -101 | ir_mode_tbl_sz | IDF_NO_ENTRY received from read_idf |
| EXP_IDF_NOT_FOUND | -102 | ir_alloc_exp_once | IDF_NOT_FOUND returned from read_idf |
| EXP_IDF_MANY_BYTES | -103 | ir_alloc_exp_once | IDF_MANY_BYTES received from read_idf |
| EXP_IDF_TBL_NUM | -104 | ir_alloc_exp_once | IDF_TBL_NUM received from read_idf |
| EXP_IDF_CON_NUM | -105 | ir_alloc_exp_once | IDF_CON_NUM received from read_idf |
| EXP_IDF_NO_ENTRY | -106 | ir_alloc_exp_once | IDF_NO_ENTRY received from read_idf |
| CRIT_IDF_NOT_FOUND | -107 | ir_get_critical_info | IDF_NOT_FOUND returned from read_idf |
| CRIT_IDF_MANY_BYTES | -108 | ir_get_critical_info | IDF_MANY_BYTES received from read_idf |
| CRIT_IDF_TBL_NUM | -109 | ir_get_critical_info | IDF_TBL_NUM received from read_idf |
| CRIT_IDF_CON_NUM | -110 | ir_get_critical_info | IDF_CON_NUM received from read_idf |
| CRIT_IDF_NO_ENTRY | -111 | ir_get_critical_info | IDF_NO_ENTRY received from read_idf |
| NEW_IDF_NOT_FOUND | -112 | ir_get_new_tbl | IDF_NOT_FOUND returned from read_idf |
| NEW_IDF_MANY_BYTES | -113 | ir_get_new_tbl | IDF_MANY_BYTES received from read_idf |
| NEW_IDF_TBL_NUM | -114 | ir_get_new_tbl | IDF_TBL_NUM received from read_idf |
| NEW_IDF_CON_NUM | -115 | ir_get_new_tbl | IDF_CON_NUM received from read_idf |
| NEW_IDF_NO_ENTRY | -116 | ir_get_new_tbl | IDF_NO_ENTRY received from read_idf |
| NEW_SCALE_MALLOC | -117 | ir_get_new_tbl | Malloc error setting up table scale array |
| CONV_CAL_VECTOR_MISMATCH | -118 | ir_convert_cal_data | Processing raw ancillary data with table whose type is not ancillary data. |
| TIMING_MALLOC | -119 | ir_alloc_timing | Malloc error setting up time offset array |
| PBACK_NO_HEADER | -120 | ir_placback_data_files | UDF header file not open |
| PBACK_NO_DATA | -121 | ir_placback_data_files | UDF data file not open |
| PBACK_NO_VIDF | -122 | ir_placback_data_files | VIDF file not open |
| NUM_CAL_MALLOC | -123 | ir_check_cal_size | Malloc error in setting up ancillary data array |
| NUM_CAL_REALLOC | -124 | ir_check_cal_size | Realloc error in increasing size of Anc Data array |
| READ_IN_MALLOC | -125 | ir_read_in_tab | Malloc error in setting up table array |
| READ_IN_IDF_NOT_FOUND | -126 | ir_read_in_tbl | IDF_NOT_FOUND returned from read_idf |
| READ_IN_IDF_MANY_BYTES | -127 | ir_read_in_tbl | IDF_MANY_BYTES received from read_idf |
| READ_IN_IDF_TBL_NUM | -128 | ir_read_in_tbl | IDF_TBL_NUM received from read_idf |
| READ_IN_IDF_CON_NUM | -129 | ir_read_in_tbl | IDF_CON_NUM received from read_idf |
| READ_IN_IDF_NO_ENTRY | -130 | ir_read_in_tbl | IDF_NO_ENTRY received from read_idf |
| CREATE_TBL_MALLOC | -131 | ir_create_tbl | Malloc error in setting up table arrays |
| CREATE_IDF_NOT_FOUND | -132 | ir_create_tbl | IDF_NOT_FOUND returned from read_idf |
| CREATE_IDF_MANY_BYTES | -133 | ir_create_tbl | IDF_MANY_BYTES received from read_idf |
| CREATE_IDF_TBL_NUM | -134 | ir_create_tbl | IDF_TBL_NUM received from read_idf |
| CREATE_IDF_CON_NUM | -135 | ir_create_tbl | IDF_CON_NUM received from read_idf |
| CREATE_IDF_NO_ENTRY | -136 | ir_create_tbl | IDF_NO_ENTRY received from read_idf |
| CONST_IDF_NOT_FOUND | -137 | ir_get_constants | IDF_NOT_FOUND returned from read_idf |
| CONST_IDF_MANY_BYTES | -138 | ir_get_constants | IDF_MANY_BYTES received from read_idf |
| CONST_IDF_TBL_NUM | -139 | ir_get_constants | IDF_TBL_NUM received from read_idf |
| CONST_IDF_CON_NUM | -140 | ir_get_constants | IDF_CON_NUM received from read_idf |
| CONST_IDF_NO_ENTRY | -141 | ir_get_constants | IDF_NO_ENTRY received from read_idf |
| DKEY_PROJECT | -145 | get_data_key | Bad UDF PROJECT acronym |
| DKEY_MISSION | -146 | get_data_key | Bad UDF MISSION acronym |
| DKEY_EXPERIMENT | -147 | get_data_key | Bad UDF EXPERIMENT acronym |
| DKEY_INSTRUMENT | -148 | get_data_key | Bad UDF INSTRUMENT acronym |
| DKEY_VINST | -149 | get_data_key | Bad UDF SUB-INSTRUMENT acronym |
| IMAGE_NOT_FOUND | -200 | start_image | Non ALL_OKAY received from locate_ex routine |
| IMAGE_READ_ERROR | -201 | start_image | UDF data read error |
| IMAGE_HDR_MALLOC | -202 | start_image | RHDR_HDR_MALLOC returned from ir_read_header |
| IMAGE_HDR_REALLOC | -203 | start_image | RHDR_HDR_REALLOC returned from ir_read_header |
| INIT_VIDF_NOT_FOUND | -204 | init_vidf | Non ALL_OKAY received from locate_ex routine |
| INIT_VIDF_BAD_VERSION | -205 | init_vidf | Unrecognized VIDF version number |
| INIT_VIDF_TBL_MALLOC | -206 | init_vidf | Malloc error in setting up the VIDF table byte offset array |
| INIT_VIDF_CONST_MALLOC | -207 | init_vidf | Malloc error in setting up the VIDF constant byte offset array |
| TBL_VAR_NOT_CAL | -224 | ir_get_tbl_info | Table type is 2 and format is lookup, but is not a function of raw ancillary data |
| CNVT_TMP_MALLOC | -228 | convert_to_units | Malloc error in setting up internal array |
| CNVT_BAD_TBL_NUM | -229 | convert_to_units | Non-existent table number used in algorithm |
| MODE_PTR_MALLOC | -230 | ir_get_mode_info | Malloc error in establishing status array |
| MODE_TBL_MISC_MALLOC | -231 | ir_get_mode_tbl | Malloc error creating mode table information arrays |
| MODE_TBL_IDF_NOT_FOUND | -232 | ir_get_mode_tbl | IDF_NOT_FOUND returned from read_idf |
| MODE_TBL_IDF_MANY_BYTES | -233 | ir_get_mode_tbl | IDF_MANY_BYTES received from read_idf |
| MODE_TBL_IDF_TBL_NUM | -234 | ir_get_mode_tbl | IDF_TBL_NUM received from read_idf |
| MODE_TBL_IDF_CON_NUM | -235 | ir_get_mode_tbl | IDF_CON_NUM received from read_idf |
| MODE_TBL_IDF_NO_ENTRY | -236 | ir_get_mode_tbl | IDF_NO_ENTRY received from read_idf |
| MODE_TBL_VAR_NOT_CAL | -237 | ir_get_mode_tbl | Type 2 table with mode as variable; only raw ancillary allowed |
| MODE_TBL_VAR_NOT_RAW | -238 | ir_get_mode_tbl | Type 0 table with processed data must be raw |
| MODE_TBL_MALLOC | -239 | ir_get_mode_tbl | Malloc error in setting up table array |
| ASCII_AFTER_SENSOR | -240 | ir_read_idf_once | ASCII table found with non-ascii table following |
| CONV_MODE_BAD_MODE | -241 | ir_convert_mode_data | Requested status byte > then number of status bytes |
| CONV_MODE_BAD_TBL_NUM | -242 | ir_convert_mode_data | Requested table number > the number of defined tables |
| CRIT_ACTION_MALLOC | -268 | ir_init_sensor_ptr | Malloc error in creating critical action array |
| CREATE_DATA_MALLOC | -272 | create_idf_data_structure | Malloc error in creating data structure |
| CREATE_ALL_MALLOC | -273 | create_idf_data_structure | Malloc error in creating data structure address array |
| CREATE_ALL_REALLOC | -274 | create_idf_data_structure | Realloc error in increasing the data structure address array size |
| CHK_DATA_NOT_FOUND | -275 | ir_check_idf_data_memory | Non ALL_OKAY received from locate_ex routine |
| RESET_PITCH_MALLOC | -277 | ir_check_dependent_on_header | Malloc error in creating pitch angle array |
| RESET_PITCH_REALLOC | -278 | ir_check_dependent_on_header | Realloc error increasing the pitch angle array size |
| PITCH_MALLOC | -279 | ir_alloc_pitch_info | Malloc error when creating pitch angle array |
| PA_TBL_MALLOC | -280 | ir_pitch_angle_tbl_info | Malloc error creating pitch angle table information arrays |
| PA_TIME_MALLOC | -281 | ir_alloc_pitch_info | Malloc error in creating pitch angle time array |
| PINFO_IDF_NOT_FOUND | -282 | ir_get_pitch_info | IDF_NOT_FOUND returned from read_idf |
| PINFO_IDF_MANY_BYTES | -283 | ir_get_pitch_info | IDF_MANY_BYTES received from read_idf |
| PINFO_IDF_TBL_NUM | -283 | ir_get_pitch_info | IDF_TBL_NUM received from read_idf |
| PINFO_IDF_CON_NUM | -285 | ir_get_pitch_info | IDF_CON_NUM received from read_idf |
| PINFO_IDF_NO_ENTRY | -286 | ir_get_pitch_info | IDF_NO_ENTRY received from read_idf |
| FILE_POS_PA | -287 | file_pos FilePosRec |
file position does not return ALL_OKAY for pitch angle UDF data |
| PA_BAD_SRC | -288 | ir_get_pitch_info | Bad magnetic field source for pitch angle calculations |
| PA_BAD_FRAC | -289 | ir_process_pitch_data | delta time divided by total time > 1 |
| PA_UNIT_NORMAL | -290 | ir_get_unit_normals | Unable to find all instrument bore sight unit normals |
| CNVT_BAD_DTYPE | -293 | convert_to_units | Bad Data Type specified in input |
| PA_BAD_TIMES | -294 | ir_fill_pitch_angles | No magnetic field data covering measurement |
| PA_MAIN_DATA_MISSING | -320 | pitch_angle_source_status | Non ALL_OKAY received from locate_ex routine |
| NEXT_FILE_TIME_NOT_FOUND | -322 | next_file_start_time | Non ALL_OKAY received from locate_ex routine |
| NEXT_FILE_TIME_FILE_OPEN | -323 | next_file_start_time | File open not called for mode data |
| NEXT_FILE_TIME_INFO_DUP | -324 | next_file_start_time | ALL_OKAY not received from locate_ex for mode data |
| RESET_CSET_MALLOC | -325 | ir_check_dependent_on_header | Malloc error setting up Anc Data set size array |
| UDF_NOT_MATRIX | -400 | BuildMatrix | UDF does not contain matrix sensors |
APPLICABLE FORMATS UDF V2.2, IDFS V2.1
SEE ALSO
| UDF V2.2 | Sept 1, 2000 | UDF V2.2 |
|---|