NAME

INQUIRE COLOUR MAPPING STATE − inquire the current colour mapping state for a specified workstation

SYNOPSIS

C Syntax

void
pinq_colr_map_st ( ws, map_method, error_ind, map_st )
Pintws;workstation identifier
Pintmap_method; mapping method
Pint∗error_ind;OUT error indicator
Pcolr_map_st∗map_st;OUT method-specific state

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE COLOUR MAPPING STATE to determine the currently available colour mapping facilities for a specified colour mapping method and a specified workstation. 

C Input Parameters

wsThe workstation identifier. 

map_method
The colour mapping method.

C Output Parameters

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

map_st
A pointer to a location in which the system returns the current colour mapping state for the specified colour mapping method. Pcolr_map_st is defined in phigs.h as:

typedef union {
Pintint_data;/∗ for map_method 1 and 2 ∗/
} Pcolr_map_st;

For colour mapping method PCOLR_MAP_TRUE, int_data will contain the number of available true colours.  For colour mapping method PCOLR_MAP_PSEUDO, int_data will contain the number of pseudo colour entries available.  There is no information returned for colour mapping method PCOLR_MAP_PSEUDO_N. 

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

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 (that is, the workstation category is not OUTPUT or OUTIN)

126Ignoring function, the specified colour mapping method is not available on the specified workstation. 

SEE ALSO

SET COLOUR MAPPING REPRESENTATION (3P)
INQUIRE COLOUR MAPPING METHOD FACILITIES (3P)

September 02, 1992