INQUIRE LIST OF COLOUR INDICES(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

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

SYNOPSIS

C Syntax

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

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. However, colour indices are nonsparse in PEX-SI: the n colour representations necessarily have indices 0 through n - 1.

C Input Parameters

wsWorkstation 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. Specify 0 to get the total length of the list.

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

C Output Parameters

error_ind
Pointer to the location for storing the error number of any error this function detects.

indicesA pointer to a Pint_list in which the system returns the portion of the list of currently defined colour indices, starting at the entry specified with start. Pint_list is defined in phigs.h as follows:

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

} Pint_list; The pointer indices→ints must be initialized to an array of length Pint elements.

total_length
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.

ERRORS

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

054Ignoring function, specified workstation is not open

059Ignoring function, specified workstation does not have output capability (in other words, the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum