Decode String into Logical True False Value

This Subprogram will attempt to decode the specified text string into a Logical (True/False) Value.

Short Name Calling Sequence

STATUS = UIDCLO(STRING,VALUE)

Long Name Calling Sequence

STATUS = UI_DECODE_LOGICAL(...)

Input Arguments

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

Output Arguments

VALUE (Logical) Decoded Value

Function Value

UI__SUCCESS ) Success UISUCC )

UI__DEFAULTED ) Defaulted UISUCC )

UI__ILLEGAL_SYNTAX ) Illegal Syntax UIILSY ) Note:

1. The UI__ILLEGAL_SYNTAX Function Value will be returned if the text string is not 'TRUE' or 'FALSE' (or truncation thereof). 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. Case (upper or Lower) is ignored in making the match.
4. All Errors are informational only, no Error Message will be issued.
5. Any leading or trailing spaces or tabs within STRING will be ignored.
6. See UI_GET_LOGICAL for further notes on Arguments.