| get_data_key (1) | UDF PROGRAMMERS MANUAL | get_data_key (1) |
|---|
SYNOPSIS
| #include "libbase_udf.h" | ||
| ByTe_2 | get_data_key | ( ByTe_2 (ByTe_1 *P, ByTe_1 *M, ByTe_1 *E, ByTe_1 *I, ByTe_1 *SI, u_ByTe_4 *key); |
INPUT DEFINITIONS
| P | - | UDF Project Acronym |
| M | - | UDF Mission Acronym |
| E | - | UDF Experiment Acronym |
| I | - | UDF Instrument Acronym |
| SI | - | UDF Sub-Instrument Acronym |
| key | - | data key representing the above UDF nodes |
DESCRIPTION get_data_key() takes the UDF Project, Mission, Experiment, Iinstrument, and Sub-Instrument acronyms and converts them into a single data key. This data key is used by almost all UDF routines to identify the UDF file being accessed.
RETURN VALUE On success, ALL_OKAY is returned, otherwise an error code is returned.
ERRORS DKEY_PROJECT No defined UDF Project Name DKEY_MISSION No such Mission under PROJECT DKEY_EXPERIMENT No such Experiment under MISSION DKEY_INSTRUMENT No such Instrument under EXPERIMENT DKEY_VINST No such Sub-Instrument under INSTRUMENT
APPLICABLE FORMATS UDF V2.2, IDFS V2.1
RESTRICTIONS None.
SEE ALSO ret_codes (1H)
| UDF V2.2 | July 31, 1999 | UDF V2.2 |
|---|