.\"##
.\" $XConsortium: p227,v 5.2 94/04/17 20:57:03 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 WORKSTATION STATE TABLE LENGTHS" 3P "29 February 1991"
.SH NAME
INQUIRE WORKSTATION STATE TABLE LENGTHS \- inquire the lengths of the workstation state tables for a specified workstation type
.IX "Workstation State Table" "INQUIRE WORKSTATION STATE TABLE LENGTHS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ws_st_table ( type, error_ind, lengths )
Pint	type;	\fIworkstation type\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pws_st_tables	*lengths;	\fIOUT lengths of workstation tables\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE WORKSTATION STATE TABLE LENGTHS\s+2 to determine the lengths of the state tables of a specified workstation type.
.SS C Input Parameters
.IP \fItype \fP
Type of workstation.
.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 \fIlengths\fP
A pointer to a Pws_st_tables data structure which returns the length of
the workstation state tables. Pws_st_tables is defined in phigs.h as:
.nf
.ta .5i +\w'Pint	'u +\w'edge_bundles;	'u
.sp .4
typedef struct {
.sp .2
	Pint	line_bundles;	/* polyline tables */
	Pint	mark_bundles;	/* polymarker tables */
	Pint	text_bundles;	/* text tables */
	Pint	int_bundles;	/* interior tables */
	Pint	edge_bundles;	/* edge tables */
	Pint	pat_reps;	/* pattern tables */
	Pint	colr_reps;	/* colour tables */
	Pint	view_reps;   	/* view tables */
.sp .2
} Pws_st_tables; 
.fi
.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)
.IP 051
Ignoring function, this information is not yet available
for this 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 "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.SM "INQUIRE WORKSTATION STATE TABLE PLUS LENGTHS (3P+)"
.fi
