Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


  >  Docs Center  >  ENVI API  >  Application Control  >  ENVI::HideExtensionFiles

ENVI::HideExtensionFiles

ENVI::HideExtensionFiles

The ENVI::HideExtensionFiles method prevents specific .pro and .sav files from appearing in the Toolbox.

Note: This method will not remove Toolbox extensions that were explicitly added with the ENVI::AddExtension method.

Example


Suppose that you create extensions named Alpha.pro, Beta.pro, and Omega.sav and move them to your local ENVI_install_dir/extensions directory. The following code shows how to hide Beta.pro from the Toolbox:

; Launch the application
e = ENVI()
 
; Hide Omega.sav from the Toolbox
e.HideExtensionFiles, 'Beta.pro'

Syntax


ENVI.HideExtensionFiles, Name

Arguments


Name

A string or string array denoting the name(s) of the files to exclude from the Toolbox. Name can consist of .pro files, .sav files, or any mixture of the two types. ENVI searches for these files in the extension deployment directories (see Write and Deploy Extensions for a list of these directories).

Keywords


Keywords are applied only during the initial creation of the object.

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

Introduced

API Version


3.2

See Also


ENVI, ENVI::AddExtension, Write and Deploy Toolbox Extensions



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us