INQUIRE SET OF OPEN WORKSTATIONS(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE SET OF OPEN WORKSTATIONS − inquire the current set of open workstations

SYNOPSIS

C Syntax

void
pinq_open_wss ( length, start, error_ind, idlist, total_length )
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pint_list∗idlist;OUT list of ws ids
Pint∗total_length;OUT length of list in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE SET OF OPEN WORKSTATIONS to obtain a list of the identifiers fo the currently open workstations.

C Input Parameters

lengthThe number of ints in the idlist output parameter for which the application has allocated memory. length is the number of list elements that the system can return in idlist→ints. If a value of 0 is used here, no data will be returned in the idlist→ints list, but the total number of elements will be returned in total_length.

startStarting position of inquiry. The elements in the list, beginning with the item number specified by start, are copied sequentially into idlist→ints until idlist→ints is full or all the elements have been copied.

C Output Parameters

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

idlistA pointer to a Pint_list in which the system returns the portion of the list of currently open workstations starting at the entry specified with start. Pint_list is defined in phigs.h as follows:

typedef struct {
Pint num_ints; /∗ number of Pints in list ∗/
Pint ∗ints;/∗ list of integers ∗/
} Pint_list;

The num_ints component specifies the number of workstation identifiers in the list.

The pointer ints must be initialized to an array, length long, of Pint elements.

total_length
A pointer to an integer in which to return the total length of the list. This is the value required for length if all the items in the list are to be returned.

Execution

If the inquired information is available, the error indicator is returned as zero and values are returned in the output parameters.

If the inquired information is not available, the values returned in the output parameters are undefined and the error indicator is set to one of the below error numbers to indicate the reason for nonavailability.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

2201Start index out of range

Museum