.\"##
.\" $XConsortium: p191,v 5.2 94/04/17 20:56:38 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 PREDEFINED EDGE REPRESENTATION" 3P "29 February 1991"
.SH NAME
INQUIRE PREDEFINED EDGE REPRESENTATION \- inquire a predefined edge representation for a workstation type
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_pred_edge_rep ( type, index, error_ind, bundle )
Pint	type;	\fIworkstation type\fP
Pint	index;	\fIpredefined index\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Pedge_bundle	*bundle;	\fIOUT predefined edge rep\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE PREDEFINED EDGE REPRESENTATION\s+2 to determine the
predefined edge representation for a specified workstation type
at a given edge index.
.
.SS C Input Parameters
.IP \fItype \fP
Type of workstation.
.IP \fIindex \fP
Entry to be returned from the workstation table of predefined edge 
representations.
.
.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 Pedge_bundle structure in which the system returns
the edge representation at \fIindex\fP in the workstation table
of predefined edge representations.  Pedge_bundle is defined in phigs.h as:
.sp .4
.nf
.ta .5i +\w'Pedge_flag     'u +\w'colr_ind;     'u
typedef struct {
.sp .2
	Pedge_flag	flag;	/* edge flag */
	Pint	type;	/* edge type */
	Pfloat	width;	/* edge width scale factor */
	Pint	colr_ind;	/* edge colour index */
.sp .2
} Pedge_bundle; 
.sp .2
.fi
Valid values for the Pedge_flag enumerated type are defined in phigs.h as:
.sp .4
.ta .5i
.nf
typedef enum {
.sp .2
	PEDGE_OFF,
	PEDGE_ON
.sp .2
} Pedge_flag
.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, \s-2*\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 051
Ignoring function, this information is not yet available
for this workstation type; open a workstation of this type
and use the specific 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 (in other words, 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 "INQUIRE EDGE FACILITIES (3P)"
.SM "SET EDGE REPRESENTATION (3P)"
.SM "INQUIRE EDGE REPRESENTATION (3P)"
.SM "INQUIRE PREDEFINED EDGE REPRESENTATION PLUS (3P+)"
.fi