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

GETCURSOR()

Syntax:     GETCURSOR([<expL>[)

Arguments:  <expL> indicates whether the cursor will be in overwrite or
            insert mode.

Returns:    A numeric value.
            This value indicates the size (height) at which the cursor was
            just displayed.

Usage:      This function will allow the current cursor form to be saved
            to a memory variable.   It will then be possible to change the
            form with SETCURSOR() (e.g., for a series of GETs) and
            then reset the form, again with SETCURSOR(), to its original
            shape which was stored with GETCURSOR().

Note:       GETCURSOR() will store the form for two cursor displays:
            one form for overwriting and one for inserting.  If <expL> is
            (.F.) or omitted, the cursor form for overwriting is returned.
            The form for inserting is returned when <expL> is (.T.) (see
            also the note with SETCURSOR()).  Each individual symbol
            will be broken down to lines on the screen.  This will also
            apply to the cursor.  The form and height of the cursor will
            be determined by two instructions.  These values will
            correspond to the first and last lines that should be used for
            displaying the cursor.  GETCURSOR() will return both
            numbers combined into one value using the following formula:

            Initial line * 256 + final line

            The initial and final lines may be separated with the functions
            NUMHIGH() and NUMLOW().  The concept of line in this case
            is not the same as screen (output) line, but denotes
            scan or pixel lines forming a symbol on the screen.  This
            function operates independently of the setting of
            SETCURSOR(), which means that SETCURSOR() will only
            switch the cursor on and off.

Library:    CT1.LIB


--------------------------------- Example ------------------------------

Examples:   cursor = GETCURSOR()


            ? NUMHIGH(cursor)           && cursor initial line
            ? NUMLOW(cursor)            && cursor final line