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

NAME

INQUIRE LIST OF COLOUR INDICES − inquire list of colour indices defined on a workstation

SYNOPSIS

C Syntax

void
pinqcolourind ( 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 colour indices
Pint∗total_length;OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqeci ( WKID, N, ERRIND, OL, COLI )
INTEGERWKIDworkstation identifier
INTEGERNlist element requested
INTEGERERRINDOUT error indicator
INTEGEROLOUT number of colour table entries
INTEGERCOLIOUT Nth element of list of colour indices

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

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

C Input Parameters

wsThe workstation identifier of the workstation whose colour 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 colour 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 colour indices is queried.

NPosition in the list of the item requested. The Nth defined colour index will be returned in COLI.

FORTRAN Output Parameters

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

OLThe total length of the list.

COLIThe Nth defined colour 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