disable_events(3G)

NAME

disable_events − disable events queuing from specified graphics input device

SYNOPSIS

C Syntax:

int disable_events ( fildes, class, ordinal );
int fildes, class, ordinal;

FORTRAN77 Syntax:

integer*4 function disable_events ( fildes, class, ordinal )
integer*4 fildes, class, ordinal

Pascal Syntax:

function disable_events ( fildes, class, ordinal:integer ):integer;

DESCRIPTION

Input Parameters

fildes Integer file descriptor returned by gopen when an I/O path to a graphics device is opened.

class One of the following device classes: LOCATOR, CHOICE or ALL. The integer values assigned for these class designators are found in the Starbase include file used with your program.

ordinal Logical device number ranging from 1 to the number of devices in the specified class. LOCATOR and CHOICE devices have device-dependent ordinal values. See inquire_input_capabilities for details. If class equals ALL, then ordinal is ignored.

Discussion

Disable_events disables the queuing of events in the Starbase event queue from the device specified by fildes, class, and ordinal. A single event queue is used by all system graphics input devices. The function returns 0 when successful.

If class is set to ALL, ordinal is ignored and events are disabled for all logical devices specified by fildes.

If the device is not initialized or does not exist, a non-zero function value is returned. If the device was not enabled for events, nothing is done and the return value is 0, indicating success.

This call does not cause flushing of the event queue.

DEFAULTS

All devices are initially disabled for event generation.

Museum

Related Articles