CBL_READ_MOUSE_EVENT

Reads the mouse event queue and returns information about an event.

Note: This routine is supported for native COBOL only.

Syntax:

call "CBL_READ_MOUSE_EVENT" using     mouse-handle
                                      event-data
                                      read-type
                            returning status-code

Parameters:

	Using call prototype (see Key)	Picture
`mouse-handle`	cblt-x4-compx	pic x(4) comp-x.
`event-data`	See Mouse Routines
`read-type`	cblt-x1-compx	pic x comp-x.
`status-code`	See Library Routines - Key

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 and then return

On Exit:

event-data: See Mouse Routines

Comments:

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.

The CBL_ mouse routines do not work with the x"AF" mouse routines.

Parent topic: Mouse Routines

Parent topic: Alphabetical List of Library Routines