Fetch Information for Next Symbol

This Subprogram may be used to fetch (retrieve) the information (Name and Equivalence Text) for all currently defined Symbols.

Short Name Calling Sequence

STATUS = UINXSB(INDEX,SYMNAM,SYMTXT[,SYMLEN,TXTLEN])

Long Name Calling Sequence

STATUS = UI_NEXT_SYMBOL(...)

Input Arguments

INDEX (Integer) Symbol Index (see Notes)

Output Arguments

INDEX (Integer) Symbol Index (see Notes) SYMNAM (Character) Symbol Name SYMTXT (Character) Symbol Equivalence Text SYMLEN (Integer) Length of Symbol Name (Optional) TXTLEN (Integer) Length of Text (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_SYMBOL ) Illegal Symbol Name UIILSB )

UI__END_OF_FILE ) Symbol Scan Completed UIEOF )

Note:

1. The INDEX Argument is used to ``walk" through the currently defined Symbols. it should be initialised to a negative number (e.g. -1) and will be setup on return from this Subprogram ready to point to the next Symbol. The UI__END_OF_FILE Function value signifies that no more Symbols exist (i.e. that the Symbol Scan is complete).
2. The SYMLEN and TXTLEN Arguments are optional and, if present, will be set to the length of the Symbol Name and Equivalence Text following any truncation.