Decode String into Integer Value

This Subprogram will attempt to decode the specified text string into an Integer Value.

Short Name Calling Sequence

STATUS = UIDCIN(STRING,VALUE)

Long Name Calling Sequence

STATUS = UI_DECODE_INTEGER(...) STATUS = UI_DECODE_INT (...)

Input Arguments

STRING (Character) Text String VALUE (Integer) Default Value

Output Arguments

VALUE (Integer) Decoded Value

Function Value

UI__SUCCESS ) Success UISUCC )

UI__DEFAULTED ) Defaulted UIDFLT )

UI__ILLEGAL_SYNTAX ) Illegal Syntax UIILSY ) Note:

1. The UI__ILLEGAL_SYNTAX Function Value will be returned if the text string does not conform to the correct Integer syntax (see Notes for UI_GET_INTEGER). No modification will be made to the default value in this case.
2. The UI__DEFAULTED Function Value indicates that the specified String is null (all spaces).
3. All Errors are informational only, no Error Message will be issued.
4. Any leading or trailing spaces or tabs within STRING will be ignored.
5. See UI_GET_INTEGER for further notes on Arguments.