ENVINITF::GetDESData

The GetDESData method retrieves the raw data from a specified data extension segment (DES).

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)

 

; Print the text string within the DES

Print, STRING(NITF.GetDESData(0))

 

Result:

This is a test DES.

Syntax

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

Return Value

This method returns the raw bytes of data from a DES segment.

Arguments

DESIndex

Specify an integer with the index number of a DES. The value can range from 0 to the number of DESes, minus 1.

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

API Version

4.2

See Also

ENVINITF