Fetch Symbol Equivalence Text

This Subprogram may be used to fetch (retrieve) the Equivalence Text for the specified Symbol.

Short Name Calling Sequence

STATUS = UIFHSB(SYMNAM,SYMTXT[,TXTLEN])

Long Name Calling Sequence

STATUS = UI_FETCH_SYMBOL(...)

Input Arguments

SYMNAM (Character) Symbol Name

Output Arguments

SYMTXT (Character) Symbol Equivalence Text 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__TRUNCATED ) Text String Truncated UITRUN )

Note:

1. The SYMNAM Argument must correspond to a single currently defined Symbol.
2. The UI__TRUNCATED Function Value is informational only and indicates that the actual Equivalence Text is longer than the SYMTXT Argument.
3. The TXTLEN Argument is optional and, if present, will be set to the length of the Equivalence Text following any truncation.