.\"
.\" $XConsortium: p183,v 5.2 94/04/17 20:56:33 rws Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         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 names of Sun Microsystems,
.\" and the X Consortium 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 POLYLINE REPRESENTATION PLUS" 3P+ "29 February 1991"
.SH NAME
INQUIRE POLYLINE REPRESENTATION PLUS \- inquire the values of 
a workstation's extended polyline representation
.IX "Attribute Representations" "INQUIRE POLYLINE REPRESENTATION PLUS"
.IX "Inquiry functions" "INQUIRE POLYLINE REPRESENTATION PLUS"
.IX "PHIGS Extension Functions" "INQUIRE POLYLINE REPRESENTATION PLUS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_line_rep_plus ( ws, index, type, error_ind, rep )
Pint	ws;	\fIworkstation identifier\fP
Pint	index;	\fIpolyline index\fP
Pinq_type	type;	\fItype of returned value \fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pline_bundle_plus	*rep;	\fIOUT polyline representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE POLYLINE REPRESENTATION PLUS\s+2 
returns the
attribute values of a specified entry in a workstation
extended polyline bundle table.
See \s-2SET POLYLINE REPRESENTATION PLUS\s+2
for a full description of
the contents of the bundle table entry
and a description of the extended polyline bundle table.
.SS C Input Parameters
.IP \fIws\fP
Workstation identifier.
.IP \fIindex\fP
Index of the entry to be returned from the workstation extended polyline
bundle table.
If this entry is not present in the table, and the
type of returned value
parameter is \s-2PINQ_REALIZED\s+2, the representation for polyline index one is
returned.
.IP \fItype\fP
An enumerated value specifying whether the values to be returned are 
those originally specified by the application (\s-2PINQ_SET\s+2), or
those resulting after \s-2PHIGS\s+2 mapped them to ones available on the
workstation (\s-2PINQ_REALIZED\s+2).  A Pinq_type structure is defined as:
.nf
.ta .5i +\w'PINQ_REALIZED     'u
.sp .4
typedef enum {
.sp .2
	PINQ_SET,
	PINQ_REALIZED
.sp .2
} Pinq_type;
.fi
.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 \fIrep\fP
A pointer to a Pline_bundle_plus structure that returns the
specified extended polyline representation.
Pline_bundle_plus is defined as:
.nf
.ta .5i +\w'Pgcolr     'u +\w'*approx_val;     'u
.sp .4
typedef struct {
.sp .2
	Pint	type;	/* line type */
	Pfloat	width;	/* linewidth scale factor */
	Pgcolr	colr;	/* polyline colour */
	Pint	shad_meth;	/* polyline shading method */
	Pint	approx_type;	/* curve approximation type */
	Pfloat	approx_val;	/* curve approximation value */
.sp .2
} Pline_bundle_plus;
.fi
.IP
See \s-2SET POLYLINE REPRESENTATION PLUS\s+2
for a full description of the contents of this structure.
.SS Execution
.LP
If the inquired information is available, the error indicator is returned
as zero and the requested information is returned in the output parameters.
.LP
If the specified polyline index is not present in the polyline bundle table
on the workstation and the specified type of returned value is 
\fIRealized\fP,
the representation for polyline index one is returned.
.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
non-availability.
.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 003
Ignoring function, function requires state (\s-2PHOP, WSOP, *, *\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.IP 059
Ignoring function, the specified workstation does not have output
capability (that is, the workstation category is neither \s-2OUTPUT\s+2,
\s-2OUTIN\s+2, nor \s-2MO\s+2)
.IP 100
Ignoring function, the bundle index value is less than one
.IP 101
Ignoring function, the specified representation has not been defined
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET POLYLINE REPRESENTATION PLUS (3P+)"
.SM "INQUIRE POLYLINE REPRESENTATION (3P)"
.SM "INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS (3P+)"
.fi