.\"
.\" $XConsortium: p094,v 5.2 94/04/17 20:55:25 rws Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         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 names of Sun Microsystems,
.\" and the X Consortium 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.
.ds f \s-2INQUIRE COLOUR MAPPING FACILITIES\s+2
.TH "INQUIRE COLOUR MAPPING FACILITIES" 3P+ "29 February 1991"
.SH NAME
INQUIRE COLOUR MAPPING FACILITIES \- inquire colour mapping facilities for
the specified workstation type
.IX "Inquiry functions" "INQUIRE COLOUR MAPPING FACILITIES"
.IX "PHIGS Extension Functions" "INQUIRE COLOUR MAPPING FACILITIES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void 
pinq_colr_map_facs ( type, length, start, error_ind, colr_map_facs, total_length )
Pint	type;	\fIworkstation type\fP
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pcolr_map_facs	*colr_map_facs;	\fIOUT colour mapping facilities\fP
Pint	*total_length;	\fIOUT total length of list\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE COLOUR MAPPING FACILITIES\s+2
returns the available colour mapping facilities for a specified
workstation type.
.SS C Input Parameter
.IP \fItype\fP
The workstation type.
.IP \fIlength\fR
The number of Pint entries in the array the application has allocated and
assigned to \fIcolr_map_facs\fR\(->\fImethods.ints\fR.
If zero is specified then the list of available colour mapping methods will
not be returned, but the number of available colour mapping methods will be
returned in the \fItotal_length\fR argument.
.IP \fIstart\fR
Starting position of inquiry.  The elements in the list, beginning
with the item number specified by \fIstart\fR, are copied sequentially into 
\fIcolr_map_facs\(->methods.ints\fR until \fIcolr_maps_facs\(->methods.ints\fR is full
or all the elements have been copied.
.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 \fIcolr_map_facs\fP
A pointer to to the variable in which to store the colour mapping facilities.
Pcolr_map_facs is defined in phigs.h as:
.ta .5i +1i +1.25i
.nf
.sp .2
typedef struct {
.sp .2
	Pint_list	meths;	/* available colour mapping methods */
	Pint	num_pred_inds;	/* number of predefined indices */
.sp .2
 } Pcolr_map_facs;
.sp .2
.fi
.IP
\fInum_pred_ind\fP returns the number of predfined colour mapping
representations.
.IP
\fImeths\fP returns the number and list of available colour mapping
methods for the specified workstation type.
Pint_list is defined in phigs.h as follows:
.nf
.ta .5i +1i +1.25i
.sp .4
typedef struct {
.sp .2
	Pint	num_ints;	/* number of Pints in list */
	Pint	*ints;	/* list of integers        */
.sp .2
} Pint_list;
fi
.IP
The \fInum_ints\fR component specifies the number of elements in the list.
The \fIints\fR component is a pointer to a list \fInum_ints\fR long.
.IP
The application must allocate memory for \fIlength\fR elements in the
list of \fIints\fR.
.IP
The pre-defined colour mapping methods in phigs.h are:
.nf
.ta .5i +.5i
	1	PCOLR_MAP_TRUE
	2	PCOLR_MAP_PSEUDO
	3	PCOLR_MAP_PSEUDO_N
.fi
.IP \fItotal_length\fR
A pointer to the integer in which to return the length of the list.
This is the value required for \fIlength\fR if all the items in the 
list are to be returned.
.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.
.SS Errors
.IP 002
Ignoring function, function requires state (\s-2PHOP,*,*,*\s+2)
.IP 051
Ignoring function, this information is not yet available for this generic
workstation type; open a workstation of this type and use the specific 
workstation type
.IP 052
Ignoring function, workstation type not recognized by the implementation
.IP 059
Ignoring function, the specified workstation does not have output capability
(i.e. the workstation category is neither \s-2OUTPUT\s+2, \s-2OUTIN\s+2, nor \s-2MO\s+2)
.IP 062
Ignoring function, this information is not available for this
\s-2MO\s+2 workstation type
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET COLOUR MAPPING REPRESENTATION (3P+)"
.SM "SET COLOUR MAPPING INDEX (3P+)"
.fi
