envGetAvailableTools

envGetAvailableTools( )
=> l_availableTools

Description

Allows users to know which tools are available to be loaded.

The return value from envGetAvailableTools is different if the shell environment variable CDS_LOAD_ENV is set to CSF. If this has been set, it returns a list of tools that have been found using CSF.

So, for example, if CDS_LOAD_ENV is unset, or not set to CSF, then:

envGetAvailableTools may return ("ui"), indicating that only the "ui" tool is available.

However, when CDS_LOAD_ENV is set to CSF, in addition to ("ui") being returned, the tool checks all top-level directories in CSF (as specified by setup.loc) for files that end in .cdsenv.

The case remains the same if csfLookupConfig is being used and it has a setting of: INCLUDE .cdsenv.

Arguments

None

Values Returned

l_availableTools

The list of tools that are available to be loaded.

Related Topics

Cdsenv Editor Functions

Specifying CSF Search for Additional Files

The setup.loc File Location

Return to top