ENVINITF::GetDESUserDefinedDataFields

The GetDESUserDefinedDataFields method retrieves user-defined data field names of selected Data Extension Segments (DESes) in a NITF file.

Example

; Start the application

e = ENVI(/HEADLESS)

; Open a NITF file

File = FILEPATH('DESExample.ntf', ROOT_DIR=e.ROOT_DIR, $

SUBDIRECTORY = ['data', 'NITFExamples'])

NITF = ENVINITF(File)

; Get the fields in the DES user defined data

Print, NITF.GetDESUserDefinedDataFields(1)

Result:

QUAL_FLAG_ATT INTERP_TYPE_ATT INTERP_ORDER_ATT ATT_TYPE ECI_ECF_ATT DT_ATT DATE_ATT T0_ATT NUM_ATT Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 RESERVED_LEN

Syntax

Result = ENVINITF.GetDESUserDefinedDataFields(DESIndex [, ERROR=value])

Return Value

This method returns a string array of field names in the header.

Arguments

DESIndex

Specify an integer with the index number of a DES that contains a user-defined data.

Keywords

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5.6.3

Introduced

API Version

4.2