NAME

INQUIRE LIST OF COLOUR MAPPING INDICES - inquire for the list of defined colour mapping indices on a workstation

SYNOPSIS

C Syntax

void

pinq_list_colr_map_inds ( ws, length, start, error_ind, colr_map_inds, total_length )

Pint       ws;                workstation identifier
Pint       length;            length of application list
Pint       start;             starting position
Pint       * error_ind;       OUT error indicator
Pint_list  * colr_map_inds;   OUT list of polyline indices
Pint       * total_length;    OUT length of list in PHIGS

FORTRAN Syntax

SUBROUTINE pqecmi ( WKID, N, ERRIND, NCMI, CMI )

INTEGER      WKID        workstation identifier
INTEGER      N           list element requested
INTEGER      ERRIND      OUT error indicator
INTEGER      NCMI        OUT number of colour mapping indices
INTEGER      CMI         OUT Nth element of list of colour mapping indices

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE LIST OF COLOUR MAPPING INDICES inquires for a list of the currently defined workstation colour mapping indices.

C Input Parameters

ws

The workstation identifier of the workstation whose colour mapping indices are to be returned.

length

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

start

Starting position of inquiry. The elements in the list, beginning with the item number specified by start, are copied sequentially into colr_map_inds .ints until colr_map_inds .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.

colr_map_inds

A pointer to a Pint_list data structure containing the list of colour mapping

indices. A Pint_list structure is defined as:

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

total_length

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

FORTRAN Input Parameters

WKID

The workstation identifier of the workstation whose colour mapping indices are to be returned.

N

The index of the element requested from the list of colour mapping indices. If a value of 0 is used, then no data is returned in CMI, but the number of available indices is returned in NCMI.

FORTRAN Output Parameters

ERRIND

The error number of any error detected by this function.

NCMI

The number of colour mapping indices defined on the specified workstation.

CMI

The Nth element of the list of colour mapping indices.

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 following 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

003

Ignoring function, function requires state (PHOP, WSOP, * ,* )

054

Ignoring function, the specified workstation is not open

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT or OUTIN)

SEE ALSO

SET COLOUR MAPPING REPRESENTATION (3PP)

SET COLOUR MAPPING INDEX (3PP)

INQUIRE COLOUR MAPPING REPRESENTATION (3PP)