.\"##
.\" $XConsortium: p138,v 5.2 94/04/17 20:56:02 rws 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 GENERALIZED STRUCTURE ELEMENT FACILITIES" 3P "29 February 1991"
.SH NAME
INQUIRE GENERALIZED STRUCTURE ELEMENT FACILITIES
\- inquire list of GSE facilities
.IX "Generalized Structure Elements" "INQUIRE GENERALIZED STRUCTURE ELEMENT FACILITIES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_gse_facs ( length, start, error_ind, gse, total_length )
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pgse_id_dep_list	*gse;	\fI\s-2OUT\s+2 list of \s-2GSE\s+2 ids and their dependencies\fP
Pint	*total_length;	\fI\s-2OUT\s+2 length of list in \s-2PHIGS\s+2\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE GENERALIZED STRUCTURE ELEMENT FACILITIES\s+2
to obtain a list of the \s-2GSE\s+2 identifiers supported, and whether each
is workstation-independent (i.e. supported on all workstations)
or workstation-dependent (i.e. supported on some, but not all workstations).
.SS C Input Parameters
.IP \fIlength\fP
The number of elements for which memory is allocated in the output
parameter \fIgse\fP.
0 may be specified, in order to get the \fItotal length\fP of the list.
.IP \fIstart\fP
Starting position in the list at which to begin the inquiry.
.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 \fIgse\fP
A pointer to a Pgse_id_dep_list
in which the system returns the portion of the
\fIlist of \s-2GSE\s+2 identifiers\fP from the
\s-2PHIGS\s+2 description table, starting with \fIstart\fP.
Pgse_id_dep_list is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pgse_id_dep     'u +\w'num_id_facs;     'u
.sp .4
typedef struct {
.sp .2
	Pint	num_id_facs;	/* number of identifiers/dependency element */
	Pgse_id_dep	*id_facs;	/* list of \s-2GSE\s+2 facilities */
.sp .2
} Pgse_id_dep_list;
.fi
.IP
The pointer \fIgse\fR\(->\fIid_facs\fP must be initialized to an array of
\fIlength\fP Pgse_id_dep elements, defined as:
.nf
.ta .5i +\w'Pws_dep_ind     'u +\w'ind;     'u
.sp .4
typedef struct {
.sp .2
	Pint	id;	/* GSE identifier */
	Pws_dep_ind	ind;	/* WS independent/dependent indicator */
.sp .2
} Pgse_id_dep;
.fi
.IP
Pws_dep_ind is an enumerated type, with values:
.nf
.ta .5i +\w'PWS_INDEP     'u
.sp .2
	PWS_INDEP	\fIWorkstation independent\fP
	PWS_DEP	\fIWorkstation dependent\fP
.fi
.sp .2
.IP \fItotal_length\fP
A pointer to an integer in which to return the total length of the list.
This is the value required for \fIlength\fP if all the items in the list
are to be returned.
.SH ERRORS
.IP 002
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2*\s+2, \s-2*\s+2, \s-2*\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "GENERALIZED STRUCTURE ELEMENT (3P)"
.SM "INQUIRE LIST OF AVAILABLE GENERALIZED STRUCTURE ELEMENTS (3P)"
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.fi
