The UDF IDL Interface is built around a small number of IDL registered routines together with a number of KEYWORDS. This section provides descriptions of the UDF interface routines presented in much the same manner as would be routines in an programmers manual. Routine input parameters which are encased in {} are optional inputs. A detailed description of both the available KEYWORDS and the returned IDL data structure are given in later sections.
The current UDF IDL interface routines are:
| Routine | Definition |
|---|---|
| UDF_CLOSE | Frees all memory associated with a UDF source |
| UDF_JUMPTIME | Jump to a specified time in a UDF file. |
| UDF_EOF | Returns flag indicating if requested end time of data exceeded. |
| UDF_KEY | Returns a UDF key for UDF source. |
| UDF_OPEN | Opens a UDF data set and returns a pointer to the internal structure associated with it. |
| UDF_READ | Returns a pointer to an IDL structure containing the UDF data acquired from the current read operation. |
| UDF_TIMES | Returns a pointer to an IDL structure containing the start and stop times of all UDF files online for a specified source. |
| &larr Previous | TOC | HOME | Next &rarr |
| Installation | UDF_CLOSE |