.\"
.\" $XConsortium: p199,v 5.2 94/04/17 20:56:43 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 PREDEFINED POLYLINE REPRESENTATION PLUS" 3P+ "29 February 1991"
.SH NAME
INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS \- inquire 
a predefined extended polyline representation from a
specified workstation type
.IX "Inquiry functions" "INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS"
.IX "PHIGS Extension Functions" "INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_pred_line_rep_plus ( type, index, error_ind, bundle )
Pint	type;	\fIworkstation type\fP
Pint	index;	\fIpredefined index\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pline_bundle_plus	*bundle;	\fIOUT predefined polyline rep\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE PREDEFINED POLYLINE REPRESENTATION PLUS\s+2
returns the
attribute values of a specified predefined entry in the
extended polyline bundle table of a workstation type's workstation
description 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.
.ig XX
.LP
This is a \s-2PHIGS\s0 Extension function based on
\s-2PHIGS PLUS\s+2 and is not part of the 
\s-2PHIGS\s+2 standard.
.XX
.SS C Input Parameters
.\" All of the following data types are predefined in phigs.h.
.IP \fItype \fP
The workstation type.
.IP \fIindex \fP
Index of the predefined entry to be returned.
.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 \fIbundle\fP
A pointer to a Pline_bundle_plus structure that returns the
requested 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 criteria */
	Pfloat	approx_val;	/* curve approximation criteria */
.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 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
.IP 100
Ignoring function, the bundle index value is less than one
.IP 102
Ignoring function, the specified representation has not been predefined
on this workstation
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "SET POLYLINE REPRESENTATION PLUS (3P+)"
.SM "INQUIRE POLYLINE REPRESENTATION PLUS (3P+)"
.SM "INQUIRE PREDEFINED POLYLINE REPRESENTATION (3P)"
.fi
