INQUIRE INPUT QUEUE OVERFLOW(3P) — SUNPHIGS LIBRARY

NAME

INQUIRE INPUT QUEUE OVERFLOW − inquire the input queue overflow state of the PHIGS error state list

SYNOPSIS

C Syntax

void
pinqinputoverflow ( error_ind, ws, class, dev )
Pint∗error_ind;OUT error indicator
Pint∗ws;OUT workstation identifier
Piclass∗class;OUT input class
Pint∗dev;OUT input device number

FORTRAN Syntax

SUBROUTINE pqiqov ( ERRIND, WKID, ICL, IDN )
INTEGERERRINDOUT error indicator
INTEGERWKIDOUT workstation identifier
INTEGERICLOUT input class
INTEGERIDNOUT input device number

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE INPUT QUEUE OVERFLOW to retrieve the input queue overflow information from the PHIGS error state list.

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

wsA pointer to a Pint in which to store the workstation identifier of the workstation associated with the input device that caused the overflow.

classA pointer to a Piclass structure in which to store the class of the input device that caused the overflow.

class is an enumerated type that may assume the following values:

• PI_NONE
• PI_LOCATOR
• PI_STROKE
• PI_VALUATOR
• PI_CHOICE
• PI_PICK
• PI_STRING

dev A pointer to a Pint in which to store the number of the input device that overflowed the input queue.

FORTRAN Output Parameters

ERRIND
The error number of any error detected by this function.

WKIDThe workstation identifier of the workstation associated with the input device that caused the overflow.

ICLThe class of the input device that caused the overflow, Valid classes as defined in phigs77.h are:

• PNCLAS(None)
• PLOCAT(Locator)
• PSTROK(Stroke)
• PVALUA(Valuator)
• PCHOIC(Choice)
• PPICK (Pick)
• PSTRIN(String)

IDNThe number of the input device that overflowed the input queue.

Execution

When the input queue overflows, the identification of one of the logical input devices that caused the overflow is placed in the error state list. This information remains in the error state list until:

• The workstation associated with the input device is closed.
• PHIGS is closed.
• This function is called.

Calling this function clears the input queue overflow information in the error state list. If the input queue has not overflowed since this function or OPEN PHIGS was last called the appropriate error will be returned in error indicator.

When the input queue overflows, no more events can be added to it until AWAIT EVENT is called with the queue empty, i.e., all events must be removed from the queue, and AWAIT EVENT called while the queue is empty before any new events can be added.

ERRORS

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

257Ignoring function, input queue has not overflowed

258Warning, input queue has overflowed, but associated workstation has been closed

Museum