INQUIRE LIST OF PATTERN INDICES(3P) — SUNPHIGS LIBRARY

NAME

INQUIRE LIST OF PATTERN INDICES − inquire list of pattern indices defined on a workstation

SYNOPSIS

C Syntax

void
pinqpatind ( ws, length, start, error_ind, indices, total_length )
Pintws;workstation identifier
Pintlength;length of application list
Pintstart;starting position
Pint∗error_ind;OUT error indicator
Pintlst∗indices;OUT list of pattern indices
Pint∗total_length;OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqepai ( WKID, N, ERRIND, OL, PAI )
INTEGERWKIDworkstation identifier
INTEGERNlist element requested
INTEGERERRINDOUT error indicator
INTEGEROLOUT number of pattern table entries
INTEGERPAIOUT Nth element of list of pattern indices

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE LIST OF PATTERN INDICES to obtain a list of the currently defined pattern indices on the specified workstation. The defined pattern table indices are “conceptually sparse”: a PHIGS implementation could allow definition of n pattern representations with arbitrary indices. In SunPHIGS, however, pattern indices are “nonsparse”: the n pattern representations necessarily have indices 1 through n.

C Input Parameters

wsThe workstation identifier of the workstation whose pattern indices are to be returned.

lengthNumber of items for which the application has allocated memory in the output parameter indices. 0 may be specified, in order to get the total length of the list.

startStarting position in the list at which to begin the inquiry.

C Output Parameters

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

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.

indicesA pointer to a Pintlst in which the system returns the portion of the list of currently defined pattern indices, starting at the entry specified with start.

Pintlst is defined in phigs.h as follows:

typedef struct {
Pintnumber;/∗ number of Pints in list ∗/
Pint∗integers;/∗ list of integers ∗/

} Pintlst; The pointer indices->integers must be initialized to an array of length Pint elements.

FORTRAN Input Parameters

WKIDThe workstation identifier of the workstation whose list of pattern indices is queried.

NPosition in the list of the item requested. The Nth defined pattern index will be returned in PAI.

FORTRAN Output Parameters

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

OLThe total length of the list.

PAIThe Nth defined pattern index.

ERRORS

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

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum