Prompt for Text List of Values

This Subprogram will prompt for the Operator to supply a List of Text Values. The specified Prompt will only be issued if the Operator has not anticipated the input request.

Short Name Calling Sequence

         STATUS = UIGTTL(PROMPT,VALUES,VASIZE,
     &                  NVALUE[,MINCHA,MAXCHA])

Long Name Calling Sequence

         STATUS = UI_GET_TEXT_LIST(...)

Input Arguments

         PROMPT (Character)     Prompt Text
         VASIZE (Integer)       Maximum No. of Values
         MINCHA (Integer)       Minimum Length (Optional)
         MAXCHA (Integer)       MAximum Length (Optional)

Output Arguments

         VALUES (Char Array)    Response Values Array
         NVALUE (Integer)       No. of returned Values

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_LIMITS ) Illegal Limit UIILLI ) specification

UI__TRUNCATED ) List truncated UITRUN )

UI__INPUT_ABORTED ) Input Aborted (Ctrl-Z) UIABRT )

UI__NO_INPUT ) No Input present UINOIN )

UI__END_OF_FILE ) End-of-File detected UIEOF ) in Batch Mode Note:

1. The VALUES Character Array should be dimensioned (VASIZE). On return it will be setup to contain NVALUE entries, each specifying a Text String List Element.
2. The length of allowed text items may be limited by specifying the optional MINCHA and MAXCHA Arguments. If these are present they represent an inclusive range; if absent, each text item may be up to 256 characters long.
3. It is the Programmers responsibility to ensure that MINCHA (if specified) is not greater than MAXCHA. Should this unphysical condition be the case, then Function Value UI__ILLEGAL_LIMITS will be returned.
4. Unlike the other Prompted Input Subprograms UI_GET_TEXT_LIST does not accept any Defaults. If a null response (all spaces) is returned then NVALUE will be set to zero, indicating that no Elements are present.
5. The UI__TRUNCATED Return indicates that the list Array VALUES has been exceeded. Excess list elements have therefore been lost.
6. The UI__INPUT_ABORTED Function Value indicates that the User typed Ctrl-Z to abort input. This is only implemented on a VAX/VMS system. It is an informational function value only, no error message will be reported.
7. UI__NO_INPUT will only be returned in Asynchronous Mode (if both UI_INPUT_MODE and UI_GET_MODE have signified Asynchronous Input Mode) and indicates that the User has not yet specified any Input. The Application Program should poll by either calling this Subprogram repeatedly or by calling UI_TEST_INPUT repeatedly until this indicates that some Input has been received. In the latter case (UI_TEST_INPUT called) this Subprogram should be recalled in order to decode the input. UIPACK is setup by default such that this subprogram always acts synchronously unless a prior call to UI_GET_MODE has been made within the Application Program.
8. The UI__END_OF_FILE Function Value indicates that an End-of-File was detected on the main Input Stream in Batch or non-interactive mode where Input is not taken from a terminal but rather from a file. It is a severe error and therefore causes an error to be reported (unless this has been inhibited by a prior call to UI_ERROR_LEVEL).
9. The Prompt string will only be issued if the response is not already present in the input line. Thus this subprogram may be used by itself to accept input values, as part of the general decoding of a Command Line to prompt for Parameters associated with the present Verb, or to prompt for and pickup the value associated with a Qualifier.
10. The format of the Prompt is:-

    Prompt String [Text List]:
    

11. The format of allowed responses is:-

    ?
    (text1,text2,text3)
    "text1,text2,text3"
    'text1,text2 text3'
    
    where:
    
    ?       Request for Help