Copyright Digital Equipment Corp. All rights reserved.

Description

   UTIL$CQUAL_CONFIRM_ACT prompts the user for confirmation. You
   must supply at least one prompt string to this routine. If you
   supply both strings, you should have an expanded and condensed
   form of the prompt. The condensed form should be supplied through
   the prompt_string_1 parameter; the expanded form through prompt_
   string_2. The prompt string supplied by prompt_string_1 is
   initially used if the prompt_string_1 is present, does not have a
   length of zero, and either:

   o  The current_form parameter is not specified

   o  The current_form parameter is specified and contains:

      -  UTIL$K_CQF_SHORT

      -  UTIL$K_CQF_UNSPECIFIED

      -  A value greater than UTIL$K_CQF_MAX_FORM

   The prompt string supplied by prompt_string_2 is used initially
   if prompt_string_2 is present, does not have a length of zero,
   and either:

   o  prompt_string_1 is not present or has a length of zero

   o  The current_form parameter is specified and contains the value
      UTIL$K_CQF_LONG

   Once the initial form is displayed, the user can switch between
   the two forms by responding to the prompt with either CONDENSED
   or EXPANDED. The user can only switch to another form if there
   was a prompt string provided for that form. Responding with
   either CONDENSED or EXPANDED causes a reprompt to occur, even
   if the current display form was not switched.

   If a prompt routine is provided, the routine is called with the
   address of the prompt string descriptor in the first parameter,
   and the string descriptor address to receive the user's response
   in the second parameter. The routine returns a success status or
   RMS$_EOF.

   If an unsuccessful status other than RMS$_EOF is received, then
   UTIL$CQUAL_CONFIRM_ACT exits without processing any response
   in the response buffer (the second parameter that was passed to
   the prompt routine). UTIL$CQUAL_CONFIRM_ACT returns the status
   received from the user prompt routine. The prompt routine is
   responsible for end-of-file processing, and must return RMS$_EOF
   when appropriate. If an optional prompt routine is provided, it
   should be provided for all calls to UTIL$CQUAL_CONFIRM_ACT. Not
   doing so can cause unpredictable end-of-file processing.

   When the user is prompted, they may respond with the following:

   Table 3-3 Prompt Responses

   Positive  Negative
                      Stop       Stop       Switch
   Response  Response Processing Prompting  Prompts

   YES       NO       QUIT       ALL        CONDENSED
   TRUE      FALSE    Ctrl/Z                EXPANDED
   1         0
             <Return>

                                  NOTE

      Entering ALL assumes that subsequent files are a positive
      response from the user, and no further prompting occurs.
      The routine UTIL$CQUAL_FILE_MATCH properly handles this
      response. Since UTIL$CQUAL_CONFIRM_ACT does not contain
      context from a previous call, callers of this routine
      should not call UTIL$CQUAL_CONFIRM_ACT if the user has
      previously responded ALL unless the application needs
      explicit confirmation on certain items.

   The user can use any combination of uppercase and lowercase
   letters for word responses. Word responses can be abbreviated
   to one or more letters (for example, T, TR, or TRU for TRUE), but
   these abbreviations must be unique.

   After a valid response is received from the user, the procedure
   returns the current_form parameter. The current_form parameter
   contains the last form presented to the user if it was specified
   and write access is permitted.