.\"##
.\" $XConsortium: p187,v 5.2 94/04/17 20:56:35 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 POSTED STRUCTURES" 3P "29 February 1991"
.SH NAME
INQUIRE POSTED STRUCTURES \- inquire the list of structures
posted to a workstation
.IX "Priority, Display Priority" "INQUIRE POSTED STRUCTURES"
.IX "Display Priority" "INQUIRE POSTED STRUCTURES"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_posted_structs ( ws, length, start, error_ind, list, total_length )
Pint	ws;	\fIworkstation identifier\fP
Pint	length;	\fIlength of application list\fP
Pint	start;	\fIstarting position\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pposted_struct_list	*list;	\fIOUT list of posted structures\fP
Pint	*total_length;	\fIOUT length of list in PHIGS\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE POSTED STRUCTURES \s+2 to obtain the list of
currently posted structures from a workstation's state list.
.SS C Input Parameters
.IP \fIws\fP
The \fIworkstation identifier\fP of the workstation whose state list is queried.
.IP \fIlength\fP
The number of \fIpostings\fR in the \fIlist\fR output parameter for which the 
application has allocated memory. \fIlength\fR is the number of list elements
(posted structures) that the system can return in \fIlist\(->postings\fR.
If a value of 0 is used here, no data will be returned in the \fIlist\(->postings\fR
list, but the total number of posted structures in the \s-2PHIGS\s+2 state list
will be returned in \fItotal_length\fR.
.IP \fIstart\fP
Starting position of inquiry into the \s-2PHIGS\s+2 state list of 
current structures. The elements of the list of posted structures, beginning
with the item number specified by \fIstart\fR, are copied sequentially into 
\fIlist\(->postings\fR until \fIlist\(->postings\fR is full or all the 
posted structures 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 \fIlist\fP
A pointer to a Pposted_struct_list in which the system returns the portion of the
list of currently posted structures starting at the entry specified with \fIstart\fP.
Pposted_struct_list is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pposted_struct     'u +\w'num_postings;     'u
.sp .4
typedef struct {
.sp .2
	Pint	num_postings;	/* number of structure postings */
	Pposted_struct	*postings;	/* list of postings */
.fi
.sp .2
} Pposted_struct_list;
.IP
The pointer \fIlist\(->postings\fP must be initialized to an array of \fIlength\fP 
Pstructpost elements.  Pposted_struct is defined in phigs.h as follows:
.nf
.ta .5i +\w'Pfloat     'u +\w'disp_pri;     'u
.sp .4
typedef struct {
.sp .2
	Pint	id;	/* structure id */
	Pfloat	disp_pri;	/* structure priority */
.fi
.sp .2
} Pposted_struct;
.IP \fItotal_length\fP
A pointer to an integer in which the system returns the total number of elements
in the \s-2PHIGS\s+2 state list of currently used posted structures. This is the value
required for \fIlength\fR if all posted structures are to be returned.
.
.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 neither \s-2OUTPUT\s+2,
\s-2OUTIN\s+2, nor \s-2MO\s+2) 
.SH  ALSO
.nf
.IP
.ta 0.5i
.SM "POST STRUCTURE (3P)"
.SM "INQUIRE SET OF WORKSTATIONS TO WHICH POSTED (3P)"
.SM "INQUIRE PATHS DESCENDENTS (3P)"
.fi
