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

 GETCURSOR()*
 Determines the setting for the cursor form
------------------------------------------------------------------------------
 Syntax

     GETCURSOR([<lMode>]) --> nCursorForm

     *  This function has been retained for compatibility reasons only.
        Its use in development of future applications is not recommended.
        For future applications use the SETCURSOR() function.

 Argument

     <lMode>  Sets the cursor form to the overwrite (.F.) or the insert
     (.T.) mode.  The default value (.F.) sets the cursor form to the
     overwrite mode.

 Returns

     The returned value designates how many scan lines are used to display
     the cursor.

 Description

     GETCURSOR() allows you to save the current cursor form for an input
     field in a function called with a VALID, before you change it in a UDF.
     GETCURSOR() then allows you to restore its old form before returning to
     the GET field.

     CA-Clipper Tools stores the form for two cursor displays: one for
     overwriting and one for inserting.  If <lMode>  is .F. or omitted, then
     the overwrite cursor form is returned.  If <lMode> is .T., then the
     insert cursor form is returned.  (See the note with SETCURSOR()).

     The cursor is broken down into lines on the screen called scan lines.
     The form and height of the cursor are specified by two instructions that
     correspond to the first and the last line used for the cursor display.
     GETCURSOR() returns both numbers combined into one value, according to
     the following formula:

           (Starting Line * 256) + Final Line

     The NUMHIGH() and NUMLOW() functions let you separate the starting and
     final lines very easily.

 Notes

     .  The word "line" here does not mean a screen (output) line, but
        the scan or pixel lines from which screen characters are created.

     .  This function works independently of the SET CURSOR setting.

 Example

     Break down cursor information into a starting line and a final line:

     nCursor  :=  GETCURSOR()
     ? NUMHIGH(nCursor)            // Cursor start line
     ? NUMLOW(nCursor)             // Cursor final line