UDF_OPEN UDF IDL INTERFACE MANUAL UDF_OPEN
NAME
UDF_OPEN
USAGE
fh =  UDF_OPEN ( Key, By, Bd, {Bh}, {Bm}, {Bs},
{Ey}, {Ed}, {Eh}, {Em}, {Es}, KEYWORDS )
fh =  UDF_OPEN ( Key, [By, Bd, {Bh}, {Bm}, {Bs}],
{[{Ey}, {Ed}, {Eh}, {Em}, {Es}]}, KEYWORDS )
INPUT DEFINITIONS
Key - UDF Source Key produced in call to UDF_KEY
By - Starting Year of data
Bd - Starting Day of data
Bh - Starting Hour of data
Bn - Starting Minute of data
Bs - Starting Second of data
Ey - Ending Year of data
Ed - Ending Day of data
Eh - Ending Hour of data
En - Ending Minute of data
Es - Ending Second of data
KEYWORDS - Any of the defined UDF IDL keywords
RETURN DEFINITION
fh - Index into the array where information on the opened UDF is stored.
DESCRIPTION
UDF_OPEN() opens the UDF data file associated with Key and positions the file pointer to the starting time specified in the input parameters. This routine must be called prior to any reading of the UDF data and after the call to UDF_KEY which generates the input Key value. The file pointer into the UDF data file is either positioned to the data value closest in time to the requested beginning time or to the start of the data record closest time time to the requested beginning time depending on how the PIDF blocking field is set.

The Start and Stop times can be input into the routine either as a set of integers or as two arrays of integers, one array representing the start time and one the stop time. In neither input format does the entire time field need to be specified. As a minimum both the beginning Year and Day must be given. The table below shows how the time input values are filled out for partial input. Green values are input values.

By Bd Bh Bm Bs Ey Ed Eh Em Es
2000 300 00 00 00 2000 300 23 59 59
2000 300 22 00 00 2000 300 23 59 59
2000 300 22 10 00 2000 300 23 59 59
2000 300 22 10 30 2000 300 23 59 59
2000 300 22 10 30 2000 300 23 59 59
2000 300 22 10 30 2000 301 23 59 59
2000 300 22 10 30 2000 301 01 59 59
2000 300 22 10 30 2000 301 01 30 59
2000 300 22 10 30 2000 301 01 30 50

Any options to be used in the processing of this UDF data must be set in this routine through the defined UDF IDL KEYWORDS unless UDF_KEY was called using a Keyword Definition File as input in which case the keywords have already been set.

The ending times input into this routine are not directly used but stored for use by the UDF_EOF routine.

ERRORS
USAGE : key = UDF_OPEN(Key, [BT] {[ET]})
USAGE : key = UDF_OPEN(Key, BT {ET})
UDF_OPEN : Must Have At Least BYear and BDay
UDF_OPEN : Input Name %d Must Be A Scalar
UDF_OPEN : malloc (AncInfo) failed!
File_Open : No Data For This Time Period
File_Open : %d (UdfError from file_open)
ReadIdf[MaxLen] : %d (UdfError from read_idf in getting maxlen)
ReadIdf[SampleId] : %d (UdfError from read_idf in getting sample_id)
ReadIdf[SenMode] : %d (UdfError from read_idf in getting sen_mode)
ReadIdf[AncSets] : %d (UdfError from read_idf in getting cal_sets)
ReadIdf[AncUse] : %d (UdfError from read_idf in getting cal_use)
ReadIdf[AncTarget] : %d (UdfError from read_idf in getting cal_target)
FilePos : %d (UdfError from FilePosRec)
APPLICABLE FORMATS
UDF V2.2, V2.1, IDFS V2.1
RESTRICTIONS
None.
SEE ALSO
None. ret_codes (1H)
Dec 6, 2002
&larr Previous TOC HOME Next &rarr
UDF_KEY UDF_READ