ENVINITF::GetDESUserDefinedSubheaderValue

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

The GetDESUserDefinedSubheaderValue method retrieves the value of selected Data Extension Segment (DES) user-defined subheader fields 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 value of the ATT_TYPE of the DES

; user-defined subheader

Print, NITF.GetDESUserDefinedSubheaderValue(1, 'UUID')

Result:

dbe26dc7-e003-4d29-8edb-41acc0e86b6e

Syntax

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

Return Value

This method returns a string or string array with the values of a DES subheader field.

Arguments

DESIndex

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

DESField

Specify a string with the DES subheader field name to query.

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.2