ENVINITF::WriteMetadata

The WriteMetadata function method writes metadata to a text file.

Example

; Start the application

e = ENVI(/HEADLESS)

; Open a NITF file

File = FILEPATH('MIE4NITFExample.ntf', $

ROOT_DIR=e.ROOT_DIR, SUBDIRECTORY = ['data', 'NITFExamples'])

NITF = ENVINITF(File)

; Write the NITF metadata to a text file

NITF.WriteMetadata, ‘output.txt’

Syntax

ENVINITF.WriteMetadata, OutputFilename [, ERROR=variable]

Arguments

OutputFilename

The name of the output file to write. The extension must be .txt.

Keywords

These keywords are optional.

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

Introduced

API Version

4.2