Prompt for Integer Value

This Subprogram will prompt for the Operator to supply an Integer Value. The specified Prompt will only be issued if the Operator has not anticipated the input request.

Short Name Calling Sequence

         STATUS = UIGTIN(PROMPT,VALUE[,LOLIM,HILIM])

Long Name Calling Sequence

         STATUS = UI_GET_INTEGER(...)
         STATUS = UI_GET_INT    (...)

Input Arguments

         PROMPT (Character)     Prompt Text
         VALUE  (Integer)       Default Value
         LOLIM  (Integer)       Low Limit (Optional)
         HILIM  (Integer)       High Limit (Optional)

Output Arguments

         VALUE  (Integer)       Response Value

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_LIMITS ) Illegal Limit UIILLI ) specification

UI__DEFAULTED ) Input Defaulted UIDFLT )

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 range of allowed responses may be limited by specifying the optional LOLIM and HILIM Arguments. If these are present they represent an inclusive range, if absent, the VALUE may lie in the complete range of Integer numbers.
2. It is the Programmers responsibility to ensure that LOLIM (if specified) is not greater than HILIM. Should this unphysical condition be the case, then Function Value UI__ILLEGAL_LIMITS will be returned and the Default VALUE will be unchanged.
3. The UI__DEFAULTED Function Value indicates that the User just accepted the default value (by typing RETURN only).
4. 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.
5. 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.
6. 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).
7. If the Default value is outside the specified Limits, then the User will be forced to override the default and specify a value within the Limits.
8. Hexadecimal numbers must be entered by the User as being unsigned. However numbers in the range 80000000X-FFFFFFFFX are treated as negative signed numbers.
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 [xxx]:
    

    or

    Prompt String [xxx (lll:uuu)]:
    

    where ``xxx" is the current default value as specified by the VALUE Argument on entry to this subprogram and ``lll" and ``uuu" are the lower and upper limits if specified.

11. The format of allowed responses is:-

    ?
    snn
    snnI
    xxX
    xxZ
    sooO
    
    where:-
    
    ?       Request for Help
    s       is an optional sign [+/-] 
    nn      is a string of decimal digits
    nnI     is a string of decimal digits
    xxX     is a string of hex. digits (terminated by X)
    xxZ     is a string of hex. digits (terminated by Z)
    ooO     is a string of octal digits (terminated by O)
    
    
    Examples:
    
             Response       Internal
    
             -1             -1
             FX             15
             70O            56