.\"##
.\" $XConsortium: p171,v 5.2 94/04/17 20:56:25 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 OPEN STRUCTURE" 3P "29 February 1991"
.SH NAME
INQUIRE OPEN STRUCTURE \- inquire the status of the currently opened structure
.IX "Operating States" "INQUIRE OPEN STRUCTURE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_open_struct ( error_ind, status, struct_id )
Pint	*error_ind;	\fIOUT error indicator\fP
Popen_struct_status	*status;	\fIOUT status of open structure\fP
Pint	*struct_id;	\fIOUT structure identifier\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE OPEN STRUCTURE\s+2 to determine the status of the currently open structure.
.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 \fIstatus\fP
A pointer to a Popen_struct_status enumerated type in which the
system returns the status of the currently open structure.
Values of Popen_struct_status are defined in phigs.h as follows:
.nf
.ta .5i +\w'PSTRUCT_NONE     'u
.sp
	PSTRUCT_NONE	\fINo Structure Is Open\fP
	PSTRUCT_OPEN	\fIA Structure Is Open\fP
.fi
.IP \fIstruct_id\fP
An integer pointer in which the system returns the structure identifier of the currently open structure.
This value is undefined if \fIstatus\fP is \s-2PSTRUCT_NONE\s+2.
.SH ERRORS
.IP 002
Ignoring function, function requires state (\s-2PHOP, *, *, *\s+2)
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "OPEN STRUCTURE (3P)"
.SM "CLOSE STRUCTURE (3P)"
.SM "INQUIRE STRUCTURE STATUS (3P)"
.SM "INQUIRE STRUCTURE STATE VALUE (3P)"
.fi