.\"##
.\" $XConsortium: p229,v 5.2 94/04/17 20:57:05 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 VALUE" 3P "29 February 1991"
.SH NAME
INQUIRE WORKSTATION STATE VALUE \- inquire state value of workstation
.IX "Operating States" "INQUIRE WORKSTATION STATE VALUE"
.IX "Workstations" "INQUIRE WORKSTATION STATE VALUE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_ws_st ( ws_state )
Pws_st	*ws_state;	\fIOUT workstation state\fP
.ft R
.SS Required PHIGS Operating States
(*, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE WORKSTATION STATE VALUE\s+2 to determine the current state
of the workstation. The state value can be either workstation open
(\s-2PWS_ST_WSOP\s+2) or workstation closed (\s-2PWS_ST_WSCL\s+2).
.LP
This function can be used to verify that
\s-2OPEN WORKSTATION\s+2
was successful before performing additional \s-2PHIGS\s+2
operations on the workstation.
.LP
.SS C Output Parameters
.IP \fIws_state \fP
A pointer to an enumerated variable in which the current state of the
workstation is returned.
Pws_st is defined in phigs.h as follows:
.nf
.ta .5i +\w'PWS_ST_WSOP     'u
.sp.4
typedef enum {
.sp .2
	PWS_ST_WSCL,	/* Workstation Closed */
	PWS_ST_WSOP	/* Workstation Open */
.sp .2
} Pws_st;
.sp .4
.fi
.SH ERRORS
.IP 
No Error
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE SET OF OPEN WORKSTATIONS (3P)"
.SM "OPEN WORKSTATION (3P)"
.SM "CLOSE WORKSTATION (3P)"
.SM "INQUIRE SYSTEM STATE VALUE (3P)"
.fi
