summaryrefslogtreecommitdiff
path: root/xc/unsupported/doc/PHIGS/man3/p228
blob: 5987ea9c2cc8bd7c422dd667d552a3f2dfa28d03 (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.\"##
.\" $XConsortium: p228,v 5.2 94/04/17 20:57:04 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.
.\" 1. Substitute PHIGS Extension function name (in CAPS) for "PNAME" in line be.\"low:
.ds pN INQUIRE WORKSTATION STATE TABLE PLUS LENGTHS
.TH "\*(pN" 3P+ "29 February 1991"
.SH NAME
\*(pN \- 
inquire the lengths of the extended workstation state tables 
for a specified workstation type
.IX "Workstation State Table" "INQUIRE WORKSTATION STATE TABLE PLUS LENGTHS"
.IX "Inquiry functions" "INQUIRE WORKSTATION STATE TABLE PLUS LENGTHS"
.IX "PHIGS Extension Functions" "\*(pN"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void 
pinq_ws_st_table_plus ( type, error_ind, lengths )
Pint	type;	\fIworkstation type\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pws_tables_plus	*lengths;	\fIOUT lengths of the workstation tables\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE WORKSTATION STATE TABLE PLUS LENGTHS\s+2
inquires the lengths of the extended workstation state tables 
for a specified workstation type.
.SS C Input Parameters
.IP \fItype\fP
The workstation type in question.
.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 \fIlengths\fP
A pointer to a Pws_tables_plus structure which returns the
lengths of the workstation's tables.
Pws_tables_plus is defined in phigs.h as follows:
.nf
.ta .5i +.5ii +1i
.sp .4
typedef struct {
.sp .2
	Pint	line_bundles;	/* polyline tables */
	Pint	mark_bundles;	/* polymarker tables */
	Pint	text_bundles;	/* text tables */
	Pint	int_bundles;	/* interior tables */
	Pint	edge_bundles;	/* edge tables */
	Pint	pat_reps;	/* pattern tables */
	Pint	colr_reps;	/* colour tables */
	Pint	view_reps;	/* view tables */
	Pint	dcue_rep;	/* depth cue tables */
	Pint	light_src_rep;	/* light source tables */
	Pint	colr_map_rep;	/* colour mapping tables */
.sp .2
} Pws_tables_plus;
.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 051
Ignoring function, this information unavailable for this workstation type
.IP 052
Ignoring function, workstation type not recognized by the implementation
.IP 059
Ignoring function, the specified workstation does not have output capability
(i.e. the workstation category is neither \s-2OUTPUT\s+2, \s-2OUTIN\s+2, nor \s-2MO\s+2)
.IP 062
Ignoring function, this information is not available for this
\s-2MO\s+2 workstation type
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "INQUIRE WORKSTATION STATE TABLE LENGTHS (3P)"
.SM "PHIGS WORKSTATION DESCRIPTION TABLE (7P)"
.fi