ENVINITF::GetDESUserDefinedSubheaderFields

This method has been deprecated. Please refer to ENVINITF::GetSegmentFields.

The GetDESUserDefinedSubheaderFields method retrieves user-defined subheader 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 subheader

Print, NITF.GetDESUserDefinedSubheaderFields(1)

Result:

UUID NUMAIS AISDLVL AISDLVL NUM_ASSOC_ELEM ASSOC_ELEM_ID ASSOC_ELEM_ID ASSOC_ELEM_ID RESERVEDSUBH_LEN

Syntax

Result = ENVINITF.GetDESUserDefinedSubheaderFields(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 subheader.

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.1	Introduced
ENVI 5.6.3	Deprecated

API Version

4.3