.\"##
.\" $XConsortium: p215,v 5.2 94/04/17 20:56:55 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 SYSTEM STATE VALUE" 3P "29 February 1991"
.SH NAME
INQUIRE SYSTEM STATE VALUE \- inquire state value of PHIGS
.IX "Operating States" "INQUIRE SYSTEM STATE VALUE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_sys_st ( sys_state )
Psys_st	*sys_state;	\fIOUT the system state\fP
.fi
.ft R
.SS Required PHIGS Operating States
(*, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE SYSTEM STATE VALUE\s+2 to determine the current state of
the PHIGS system. The state value may be either \fI\s-2PHIGS\s+2 open\fP (\s-2PHOP\s+2)
or \fI\s-2PHIGS\s+2 closed\fP (\s-2PHCL\s+2).
.LP
\s-2PHIGS\s+2 must be opened with the \s-2OPEN PHIGS\s+2 subroutine before any operations can be performed with the \s-2PHIGS\s+2 subroutines.
This function may be used to verify that \s-2OPEN PHIGS\s+2 was
successful before performing additional \s-2PHIGS\s+2 operations.
.SS C Output Parameters
.IP \fIsys_state \fP
A pointer to a Psys_st enumerated variable in which the current state
of the \s-2PHIGS\s+2 system is returned.
Values for Psys_st are defined in phigs.h as follows:
.nf
.ta .5i +1.25i
.sp .4
typdef enum {
.sp .2
	PSYS_ST_PHCL,	/* \s-2PHIGS\s+2 closed */
	PSYS_ST_PHOP	/* \s-2PHIGS\s+2 open */
.sp .2
} Psys_st;
.fi
.SH ERRORS
.IP 
None
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "OPEN PHIGS (3P)"
.SM "CLOSE PHIGS (3P)"
.SM "EMERGENCY CLOSE PHIGS (3P)"
.SM "INQUIRE ARCHIVE STATE VALUE (3P)"
.SM "INQUIRE STRUCTURE STATE VALUE (3P)"
.SM "INQUIRE WORKSTATION STATE VALUE (3P)"
.fi
