.\"##
.\" $XConsortium: p206,v 5.3 94/04/17 20:56:49 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 SET OF OPEN WORKSTATIONS" 3P "29 February 1991"
.SH NAME
INQUIRE SET OF OPEN WORKSTATIONS \- inquire the current set of open workstations
.IX "Workstations" "INQUIRE SET OF OPEN WORKSTATIONS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_open_wss ( length, start, error_ind, idlist, total_length )
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pint_list	*idlist;	\fIOUT list of ws ids\fP
Pint	*total_length;	\fIOUT length of list in PHIGS\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE SET OF OPEN WORKSTATIONS\s+2 to obtain a list of the
identifiers fo the currently open workstations.
.SS C Input Parameters
.IP \fIlength\fP
The number of \fIints\fR in the \fIidlist\fR output parameter for which the 
application has allocated memory. \fIlength\fR is the number of list elements
that the system can return in \fIidlist\(->ints\fR.
If a value of 0 is used here, no data will be returned in the \fIidlist\(->ints\fR
list, but the total number of elements will be returned in \fItotal_length\fR.
.IP \fIstart\fP
Starting position of inquiry.  The elements in the list, beginning
with the item number specified by \fIstart\fR, are copied sequentially into 
\fIidlist\(->ints\fR until \fIidlist\(->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 \fIidlist\fP
A pointer to a Pint_list
in which the system returns the portion of the
list of currently open workstations
starting at the entry specified with \fIstart\fP.
Pint_list is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pint     'u +\w'num_ints;     'u
.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\fP component specifies the number
of workstation identifiers in the list.
.IP
The pointer \fIints\fP must be initialized to an array,
\fIlength\fP long, of Pint elements.
.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.
.SS Execution
.LP
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 below 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 002
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2*\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 2201
Start index out of range
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "OPEN WORKSTATION (3P)"
.SM "CLOSE WORKSTATION (3P)"
.SM "INQUIRE WORKSTATION STATE VALUE (3P)"
.fi
