ENVINITF::GetAssociatedFiles

The GetAssociatedFiles method retrieves individual NITF files that are associated with a MIE4NITF file.

Example

This example uses a fictitious file name. Replace the file name with your own file.

; Start the application

e = ENVI(/HEADLESS)

; Open a MIE4NITF file

File = 'MIE4NITFSample.ntf'

NITF = ENVINITF(File)

; Get the associated NITF files

NITFFiles = NITF.GetAssociatedFiles(0)

Syntax

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

Return Value

This method returns a scalar or array of ENVINITF objects, one per file.

Arguments

Index

Specify a scalar or array of associated file indices for a MIE4NITF file, which can range from 0 to the number of associated files, minus 1. Use the NASSOCIATED_FILES property of ENVINITF to determine the number of associated NITF files in a MIE4NITF file.

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