ENVINITF::GetTextSegments

The GetTextSegments method retrieves the contents of one or more text segments in a NITF or MIE4NITF file.

Example

; Start the application

e = ENVI(/HEADLESS)

; Open a NITF file

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

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

NITF = ENVINITF(File)

; Get the contents of the only text segment

; in this file

Print, NITF.GetTextSegments(0)

Result:

This information goes with file person.ntf.

Syntax

Result = ENVINITF.GetTextSegments(Index [, ERROR=value])

Return Value

This method returns a string or string array with the contents of the selected text segment(s).

Arguments

Index

Specify a scalar or array of text segment indices, which can range from 0 to the number of text segments, minus one.

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