Define a Symbol

This Subprogram may be used to define a new Symbol or to modify an existing Symbol. Subsequent occurrences of the specified Symbol Name in the Input Stream will be substituted by the specified Equivalence Text String.

Short Name Calling Sequence

STATUS = UIDFSB(SYMNAM,SYMTXT)

Long Name Calling Sequence

STATUS = UI_DEFINE_SYMBOL(...)

Input Arguments

SYMNAM (Character) Symbol Name SYMTXT (Character) Symbol Text String

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_SYNTAX ) Illegal Symbol Syntax UIILSY )

UI__DUPLICATE_SYMBOL ) Duplicate Symbol Name UIDUSB )

UI__OVERFLOW ) Work Space Overflow UIOVRF )

Note:

1. The Symbol Name should conform to the correct syntax (but may be in upper or lower case) and should be unique (i.e. must not match with more than one already defined Symbol).
2. UIPACK does not check within this Subprogram whether the Equivalence String could cause recursion, but rather when the Symbol is invoked.