.\"##
.\" $XConsortium: p224,v 5.2 94/04/17 20:57: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 WORKSTATION CATEGORY" 3P "29 February 1991"
.SH NAME
INQUIRE WORKSTATION CATEGORY \- inquire the category of a specified workstation type
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ws_cat ( type, error_ind, category )
Pint	type;	\fIworkstation type\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pws_cat	*category;	\fIOUT workstation category\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE WORKSTATION CATEGORY\s+2 to determine the category 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 \fIcategory\fP
A pointer to a Pws_cat enumerated variable, in which the 
workstation category is returned.
Values for Pws_cat are defined in phigs.h as follows:
.ta .5i +1.25i
.nf
.sp .4
typedef enum {
.sp .2
	PCAT_OUT,	/* Output Only */
	PCAT_IN,	/* Input Only */
	PCAT_OUTIN,	/* Output and Input */
	PCAT_MO,	/* Metafile Output */
	PCAT_MI	/* Metafile Input */
.sp .2
} Pws_cat;
.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 052
Ignoring function, workstation type not recognized by the implementation
.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
.
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.SM "OPEN WORKSTATION (3P)"
.SM "INQUIRE WORKSTATION CLASSIFICATION (3P)"
.fi