INQUIRE LIST OF AVAILABLE WORKSTATION TYPES(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE LIST OF AVAILABLE WORKSTATION TYPES− inquire the current list of workstation types defined in the PHIGS description table

SYNOPSIS

C Syntax

void
pinq_list_avail_ws_types ( length, start, error_ind, types, length_list)
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pint_list∗types;OUT list of ws types
Pint∗length_list;OUT length of list in PHIGS

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE LIST OF AVAILABLE WORKSTATION TYPES to obtain a list of the currently available workstation types stored in the PHIGS description table. This list contains the predefined workstation types described in OPEN WORKSTATION and user-created workstation types created with WORKSTATION TYPE CREATE. User-created types are removed from this list by WORKSTATION TYPE DESTROY.

C Input Parameters

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

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

C Output Parameters

error_ind
A pointer to the location for storing the error number of any error detected by this function. See the Errors section below for possible return values.

typesA pointer to a Pint_list structure in which to return the number and list of available workstation types. Pint_list is defined in phigs.h as follows:

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

The num_ints component specifies the number of elements in the list. The ints component is a pointer to a list num_ints long.

The application must allocate memory for length elements in the list of ints.

length_list
A pointer to an integer in which the system returns the total number of elements in the list. This is the value required for length if all elements in the list are to be returned.

Execution

INQUIRE LIST OF AVAILABLE WORKSTATION TYPES returns the list of available workstation types stored in the PHIGS description table. See OPEN WORKSTATION and WORKSTATION TYPE CREATE for a description of the available workstation types and information on how to create new ones.

If this function detects an error, then the error indicator indicates the error number of the detected error and no other output data is returned, except in the cases mentioned in the C Parameters section above. If the function detects no error, then the error indicator is set to zero and the inquired information is available in the output parameters. Since this is an inquiry function, ERROR HANDLING is not invoked when this function detects an error.

ERRORS

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

2200Buffer overflow in input or inquiry function

Museum