GET_INFO

     Provides information about the current status of the editor.  Use the
     first parameter to specify the general area about which you want
     information.  Use the second parameter (a TPU string) to specify the
     exact piece of information you want.  Use the third parameter and
     subsequent parameters, in the cases where they are required, to provide
     more information required by the GET_INFO built-in.

  Syntax

     The syntax of GET_INFO depends on the kind of information you are
     trying to get.  For most uses of GET_INFO, the syntax is as follows:

     return_value := GET_INFO (parameter1, parameter2)

     TPU requires a third and, occasionally, a fourth parameter if you
     are using GET_INFO to get information about the following subjects:

        o The name of a key defined in a key map or key map list
        o The name of a specified key map in a key map list
        o Whether a procedure is user defined and how many
          parameters the procedure takes
        o Which global selection has been grabbed or lost, and
          other information on global selections
        o The global selection or input focus grab routine or
          ungrab routine
        o A widget, a widget's resource values, or a widget's
          callback parameters
        o The dimensions of a window
        o The status of a scroll bar or scroll bar slider

     For more information on the use of the third and fourth parameters, see
     the applicable GET_INFO topic.  A list of the GET_INFO topics is
     provided in this topic.

  Parameters

      parameter1  If you want GET_INFO to return information on a given
                  variable, use that variable as parameter1.  Otherwise,
                  parameter1 is a keyword specifying the general subject
                  about which GET_INFO is to return information.  The valid
                  keywords for parameter1 are:

                  o  ARRAY                o PROCESS
                  o  BUFFER               o SCREEN
                  o  COMMAND_LINE         o SYSTEM
                  o  DEBUG                o WINDOW
                  o  DEFINED_KEY          o WIDGET
                  o  KEY_MAP              o any of a number of mouse
                  o  KEY_MAP_LIST           event keywords such as
                  o  PROCEDURES             M1UP, M1DOWN, etc.

      parameter2  A TPU string constant.  This string indicates the kind
                  of information requested about the item in parameter1.

  How to Get More Detailed HELP on GET_INFO Calls

     TPU contains additional HELP covering all the valid GET_INFO calls.
     To see all the values of parameter2 (and subsequent parameters) that
     can be used with a given value of parameter1, invoke the topic for the
     appropriate value of parameter1.  For example, if you want to know what
     GET_INFO calls are available when parameter1 is a marker variable,
     invoke the topic GET_INFO(MARKER_VARIABLE).

     Each GET_INFO topic shows the possible return values for a given
     combination of parameter1, parameter2, and subsequent parameters.  For
     example, the topic GET_INFO(ANY_VARIABLE) shows that when you use any
     variable as parameter1 and the string "type" as parameter2, GET_INFO
     returns a keyword for the data type of the variable.

     Note that in some topics parameter1 is a variable, while in others
     parameter1 is a keyword.  For example, the topic
     GET_INFO(ARRAY_VARIABLE) shows what string constants can be used when
     parameter1 is an array variable, while the topic GET_INFO(ARRAY) shows
     what can be used when parameter1 is the keyword ARRAY.

     The GET_INFO topics in TPU HELP are as follows:

                                 Topics Where             Topics Where
     Topics Where                Parameter1               Parameter1
     Parameter1                  Is a Specific            Is Any Keyword
     Is a Variable               Keyword                  or Keyname
     -------------               --------------           ---------------

     GET_INFO(ANY_VARIABLE)      GET_INFO(ARRAY)          GET_INFO(ANY_KEYNAME)
     GET_INFO(ARRAY_VARIABLE)    GET_INFO(BUFFER)         GET_INFO(ANY_KEYWORD)
     GET_INFO(BUFFER_VARIABLE)   GET_INFO(COMMAND_LINE)
     GET_INFO(INTEGER_VARIABLE)  GET_INFO(DEBUG)
     GET_INFO(MARKER_VARIABLE)   GET_INFO(DEFINED_KEY)
     GET_INFO(PROCESS_VARIABLE)  GET_INFO(KEY_MAP)
     GET_INFO(RANGE_VARIABLE)    GET_INFO(KEY_MAP_LIST)
     GET_INFO(STRING_VARIABLE)   GET_INFO(MOUSE_EVENT_KEYWORD)
     GET_INFO(WIDGET_VARIABLE)   GET_INFO(PROCEDURES)
     GET_INFO(WINDOW_VARIABLE)   GET_INFO(PROCESS)
                                 GET_INFO(SCREEN)
                                 GET_INFO(SYSTEM)
                                 GET_INFO(WIDGET)
                                 GET_INFO(WINDOW)

  Examples

     my_buffer := GET_INFO (BUFFERS, "current");

     This assignment statement stores the pointer to the current buffer in
     the variable my_buffer.

     my_string := GET_INFO (my_buffer, "file_name");

     This assignment statement stores the name of the input file for
     my_buffer in the variable my_string.