THE UDF IDL INTERFACE

UDF_KEY	UDF IDL INTERFACE MANUAL	UDF_KEY

NAME

UDF_KEY

USAGE

Key =

UDF_KEY

(

'MenuFile'

)

Key =	UDF_KEY	(	'PROJECT',
			'MISSION',
			'EXPERIMENT',
			'INSTRUMENT',
			'INSTRUMENT',
			'VIRTUAL',	)

Key =	UDF_KEY	(	[	'PROJECT',
				'MISSION',
				'EXPERIMENT',
				'INSTRUMENT',
				'INSTRUMENT',
				'VIRTUAL',	])

INPUT DEFINITIONS

MenuFile	-	ASCII Keyword Definition File produced by the UdfUnits GUI Interface
PROJECT	-	UDF Project Acronym
MISSION	-	UDF Mission Acronym
EXPERIMENT	-	UDF Experiment Acronym
INSTRUMENT	-	UDF Instrument Acronym
VIRTUAL	-	UDF Virtual Instrument Acronym

RETURN DEFINITION

Key

UDF key value associated with the input UDF source

DESCRIPTION

UDF_KEY() takes a UDF source and produces its UDF key. The UDF key is used as an input into UDF_OPEN to specify the UDF file to open. UDF_KEY is called once per UDF source to be opened.

The routine accepts the input UDF source in three different formats. It will take as input an ASCII Keyword Definition File generated by the UdfUnits Pre-IDL GUI Interface. The returned Key is generated for the UDF source used to produce the Keyword Definition File. The entire Menu File is processed at this time and all internal processing parameters set. The UDF source can also be input as the set of UDF PROJECT, MISSION, EXPERIMENT, INSTRUMENT, and VIRTUAL acronyms. These can be input either as a set of 5 strings or as an array of 5 strings.

ERRORS

USAGE	:	key = UDF_KEY(['P','M','E','I','V'])
USAGE	:	key = UDF_KEY('P','M','E','I','V')
USAGE	:	key = UDF_KEY('MenuFile")
UDF_KEY	:	Only String Arguments
UDF_KEY	:	Input Name %d Must Be A String
UDF_KEY	:	Input Name %d Must Be A Scalar
GetDataKey	:	(Udf error returned from get_data_key)
CreateIdf	:	(Udf error returned from create_idf_data_structure)

APPLICABLE FORMATS

UDF V2.2, UDF V2.1, IDFS V2.1

RESTRICTIONS

None.

SEE ALSO

None. ret_codes (1H)

Dec 6, 2002

&larr Previous	TOC	HOME	Next &rarr
UDF_JUMPTIME			UDF_OPEN