Click above to get retro games delivered to your door ever month!

Function:    ALIST()

Purpose:     List the elements of an array in a screen window.

Syntax:      ALIST( array )

Arguments:   array       - The array to list.

Returns:     True if array listed successfully, false otherwise.

Description: This function is most likely to be used from within the
             Clipper debug session.  It takes an array reference as a
             parameter and permits viewing of the elements in an array.

Notes:       Since this function was designed as a tool for debugging, the
             window is positioned on the right side of the screen so as to
             overlay as little of the Clipper debug screen as possible.
             An easy enhancement would be to add window coordinates and
             some display positioning logic.

             If ALIST() is to be called from within a Clipper debug
             session, and not included in your application, you need to
             make the function available by using the EXTERNAL Alist
             statement.  This places the function name in your
             application's symbol table so the linker will bring in the
             ALIST() function code so you can call it from debug.

Example:     *-- the Clipper (Summer '87) debugger normally shows an array
             *-- as just A from within the Clipper debugger.  To show a
             *-- listing of the elements of an array, in the Summer '87
             *-- debug Expression window, enter the following:
             ALIST(array)

             *-- a screen similar to the following will appear, with
             *-- the elements of your array listed
             +----------------------------------------------------------+
             | [#]  TYPE  VALUE                                         |
             -----------------------------------------------------------|
             |  1.  C     "This is a character array element"           |
             |  2.  C     "This is a very long character array elemen...|
             |  3.  N              1                                    |
             |  4.  N              2                                    |
             |  5.  N              3                                    |
             |  6.  N             45.55555                              |
             |  7.  L     T                                             |
             |  8.  L     F                                             |
             |  9.  D     04/10/91                                      |
             | 10.  C     "The rest of the array elements are charact...|
             | 11.  C     "The rest of the array elements are charact...|
             | 12.  C     "The rest of the array elements are charact...|
             | 13.  C     "The rest of the array elements are charact...|
             | 14.  C     "The rest of the array elements are charact...|
             | 15.  C     "The rest of the array elements are charact...|
             | 16.  C     "The rest of the array elements are charact...|
             | 17.  C     "The rest of the array elements are charact...|
             | 18.  C     "The rest of the array elements are charact...|
             | 19.  C     "The rest of the array elements are charact...|
             | Press any key for next screen, Escape to quit            |
             +----------------------------------------------------------+


Source:      RL_ALIST.PRG

See also:    ADIM2()