OBJLIST

The OBJLIST function provides a list of the objects that are contained in one or more workspaces that you specify. The specified workspaces must be currently attached when you use the function.

The result, a multiline TEXT value, can be used as an argument to the OBJ function with the REFERS keyword. This usage helps in producing a cross-reference list for compilable objects, such as programs and models, in the current workspace.

Return Value

TEXT

Syntax

OBJLIST[(text-expression)]

Arguments

text-expression: A text expression that contains a single name or several names of currently attached workspaces. Each workspace name must be on a separate line of a multiline TEXT value. When you do not supply this argument, OBJLIST uses the current workspace name.

Notes

Output from OBJLIST

The list of workspace objects returned by OBJLIST has duplicates removed and it is sorted in ascending order.

Listing All Workspace Objects

OBJLIST always returns the names of all the objects in a given workspace, even when you have limited its NAME dimension.

When a Workspace Is Not Attached

When text-expression includes the name of a workspace that is not attached, OBJLIST does not return a value. Instead, it signals an error.

Examples

Example 19-9 Listing Objects in Three Workspaces

In the following example, OBJLIST returns a multiline TEXT value that includes all the objects in the three workspaces specified: mycode, mydata, and mytools. The statement

SHOW OBJLIST('mycode\nmydata\nmytools')

produces the following output.

ACTUAL
ADDFIVE
ADVERTISING
BUDGET
CITYLIST
CITYREPINIT
CITYREPS
    ...
YEAR

Example 19-10 Listing Referenced Objects

In the following example, OBJ(REFERS) returns a multiline TEXT value that contains every object from the mycode, mydata, and mytools workspaces that is referenced in the myprog program. The statement

SHOW OBJ(REFERS OBJLIST('mycode\nmydata\nmytools') 'myprog')

produces the following output.

ACTUAL
BUDGET
 ...
YEAR