.\"
.\" $XConsortium: p177,v 5.5 94/04/17 20:56:29 hersh 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.
.TH "INQUIRE PHIGS FACILITIES" 3P "26 July 1991"
.SH NAME
INQUIRE PHIGS FACILITIES\- inquire the current list of \s-2PHIGS\s+2 facilities defined in the \s-2PHIGS\s+2 description table
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_phigs_facs ( length, start, error_ind, open_ws, open_ar, num_names, char_sets, length_list, norm_filt, inv_filt )
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pint	*open_ws;	\fIOUT max. num. simultaneously open ws\fP
Pint	*open_ar;	\fIOUT max. num. simultaneously open archive files\fP
Pint	*num_names;	\fIOUT number of available names for name sets\fP      
Pint_list	*char_sets;	\fIOUT list of character sets\fP
Pint	*length_list;	\fIOUT length of list in PHIGS\fP
Pint	*norm_filt;	\fIOUT maximum length of norm filter list for ISS\fP
Pint	*inv_filt;	\fIOUT maximum length of inverted filter list for ISS\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE PHIGS FACILITIES\s+2 to obtain a list of the available
\s-2PHIGS\s+2 facilities from the \s-2PHIGS\s+2 description table.
.SS C Input Parameters
.IP \fIlength\fP
The number of list elements for which the application has allocated memory
in the output parameter \fIchar_sets\fR\(->\fIints\fP.
0 may be specified, in order to have \fIlength_list\fP
return the total number of elements in the list of character sets.
.IP \fIstart\fP
The starting position in the list at which the inquiry is to begin.
.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 \fIopen_ws\fP
A pointer to an integer that returns the
\fImaximum number of simultaneously open workstations\fP supported.
.IP \fIopen_ar\fP
A pointer to an integer that returns the
\fImaximum number of simultaneously open archive files\fP supported.
.IP \fInum_names\fP
A pointer to an integer that returns the number of available names for name sets.
.IP \fIchar_sets\fP
A pointer to a data structure that returns a portion
of the list of available character sets, starting with
the \fIstart\fP number item.
Pint_list is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pint	'u +\w'num_ints;		'u
.sp .3
typedef struct {
.sp .2
	Pint	 num_ints;	/* number of Pints in list */
	Pint	*ints;	/* list of integers */
.sp .2
} Pint_list;
.fi
.IP
Prior to calling this function, the \fIints\fR field of the Pint_list
structure must contain a pointer to an application supplied buffer.
This buffer must be at least as large as the \fIlength\fR parameter.
.IP \fIlength_list\fP
A pointer to an integer that returns the length of the list in \s-2PHIGS\s+2.
.IP \fInorm_filt\fP
A pointer to an integer that returns the
maximum length of the norm filter list for Incremental Spatial Search.
.IP \fIinv_filt\fP
A pointer to an integer that returns the
maximum length of the inverted filter list for Incremental Spatial Search.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP\s+2, *, *, *)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "PHIGS DESCRIPTION TABLE (7P)"
.fi
