summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p213
blob: 159b0363650a62ba14c832868ae4269c050ccc3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.\"##
.\" $XConsortium: p213,v 5.2 94/04/17 20:56:54 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 STRUCTURE STATE VALUE" 3P "29 February 1991"
.SH NAME
INQUIRE STRUCTURE STATE VALUE \- inquire current structure state value
.IX "Operating States" "INQUIRE STRUCTURE STATE VALUE"
.IX "Structures" "INQUIRE STRUCTURE STATE VALUE"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_struct_st ( struct_state )
Pstruct_st	*struct_state;	\fIOUT structure state\fP
.fi
.ft R
.SS Required PHIGS Operating States
(*, *, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE STRUCTURE STATE VALUE\s+2 to determine the current
structure state.  The state value may be ``structure open'' (\s-2STOP\s+2),
or ``structure closed'' (\s-2STCL\s+2).
.LP
.SS C Output Parameters
.IP \fIstruct_state \fP
A pointer to a Pstruct_st enumerated variable in which the current structure 
state value is returned.
Values for Pstruct_st are defined in phigs.h as follows:
.nf
.ta .3i +\w'PSTRUCT_ST_STOP  'u
.sp
	\s-2PSTRUCT_ST_STCL\s+2	(structure closed)
	\s-2PSTRUCT_ST_STOP\s+2	(structure open)
.fi
.SH ERRORS
.IP 
No Error
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "OPEN STRUCTURE (3P)"
.SM "CLOSE STRUCTURE (3P)"
.SM "INQUIRE OPEN STRUCTURE (3P)"
.SM "INQUIRE STRUCTURE IDENTIFIERS (3P)"
.SM "INQUIRE STRUCTURE STATUS (3P)"
.fi