.\"##
.\" $XConsortium: p097,v 5.3 94/04/17 20:55:27 hersh Exp $
.\"##
.\"## 
$XMCOPY
.\"## Copyright (c) 1990, 1991 by Sun Microsystems, Inc. 
.\"## 
.\"##                         All Rights Reserved
.\"## 
.\"## Permission to use, copy, modify, and distribute this software and its 
.\"## documentation for any purpose and without fee is hereby granted, 
.\"## provided that the above copyright notice appear in all copies and that
.\"## both that copyright notice and this permission notice appear in 
.\"## supporting documentation, and that the name of Sun Microsystems,
.\"## not be used in advertising or publicity 
.\"## pertaining to distribution of the software without specific, written 
.\"## prior permission.  
.\"## 
.\"## SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\"## INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\"## EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\"## CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\"## USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\"## OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\"## PERFORMANCE OF THIS SOFTWARE.
.TH "INQUIRE COLOUR MAPPING STATE" 3P "29 February 1991"
.SH NAME
INQUIRE COLOUR MAPPING STATE \- inquire the current colour mapping state
for a specified workstation
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_colr_map_st ( ws, map_method, error_ind, map_st )
Pint	ws;	\fIworkstation identifier\fP
Pint	map_method;	\fI mapping method \fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pcolr_map_st	*map_st;	\fIOUT method-specific state\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
.LP
Use
.SM INQUIRE COLOUR MAPPING STATE 
to determine the currently available colour mapping facilities for a
specified colour mapping method and a specified workstation.
.LP
.SS C Input Parameters
.IP \fIws\fP
The workstation identifier.
.IP \fImap_method\fP
The colour mapping method.
.SS C Output Parameters
.IP \fIerror_ind\fP
A pointer to the location to store the error number of any error
detected by this function.
.IP \fImap_st\fP
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:
.nf
.ta .5i +1i +1.25i
.sp .4
typedef union {
.sp .2
	Pint	int_data;	/* for map_method 1 and 2 */
.sp .2
} Pcolr_map_st;
.fi
.IP
For colour mapping method \s-2PCOLR_MAP_TRUE\s+2, \fIint_data\fP will contain the
number of available true colours.
For colour mapping method \s-2PCOLR_MAP_PSEUDO\s+2, \fIint_data\fP will contain the
number of pseudo colour entries available.
There is no information returned for colour mapping method \s-2PCOLR_MAP_PSEUDO_N\s+2.
.SS Execution
If the inquired information is available, the error indicator is
returned as zero and values are returned in the output parameters.
.LP
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.
.LP
Since this is an inquiry function, \s-2ERROR HANDLING\s+2 is not 
invoked when an error is detected by this function.
.SH ERRORS
.IP 003
Ignoring function, function requires state (\s-2PHOP, WSOP, *, *\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 059
Ignoring function, the specified workstation does not have output capability
(that is, the workstation category is not \s-2OUTPUT\s+2 or \s-2OUTIN\s+2)
.IP 126
Ignoring function, the specified colour mapping method is not available
on the specified workstation.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET COLOUR MAPPING REPRESENTATION (3P)"
.SM "INQUIRE COLOUR MAPPING METHOD FACILITIES (3P)"
.fi
