Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

 ◄Key► ◄Summary►                             ◄Up► ◄Contents► ◄Index► ◄Back►
────────────────────────────────────────────────────────────────────────────
 
  Description:
 
     If there are no events in the event queue, the return from this
     routine depends on the value of read-type. If read-type is zero,
     the routine returns immediately with all zero values in
     event-data. If read-type has a value of one, return is delayed
     until an event has been queued.
 
     See also: ◄Introduction to mouse routines►
 
  Parameters on Entry:
 
     mouse-handle            Mouse identifier, obtained by earlier
                             call to CBL_INIT_MOUSE.
 
     read-type               Indicates what to do if there are no
                             events in the queue:
 
                             0 = return immediately.
                             1 = wait for an event, then return.
 
  Parameters on Exit:
 
     event-data              See ◄Introduction to mouse routines►
                                    -♦-