.\"##
.\" $XConsortium: p129,v 5.2 94/04/17 20:55:55 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 EDGE REPRESENTATION" 3P "29 February 1991"
.SH NAME
INQUIRE EDGE REPRESENTATION \- inquire an edge representation on a workstation
.IX "Attribute Representations" "INQUIRE EDGE REPRESENTATION"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_edge_rep ( ws, index, type, error_ind, rep )
Pint	ws;	\fIworkstation identifier\fP
Pint	index;	\fIedge index\fP
Pinq_type	type;	\fItype of returned value\fP
Pint	*error_ind;	\fI\s-2OUT\s+2 error indicator\fP
Pedge_bundle	*rep;	\fI\s-2OUT\s+2 edge representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE EDGE REPRESENTATION\s+2 to determine the current attribute
values for a specified entry in a specified workstation's table of
defined edge representations.
.LP
See the description of the subroutine \s-2SET EDGE REPRESENTATION\s+2 for information on the meaning of these attribute values.
.SS C Input Parameters
.IP \fIws\fP
Workstation identifier.
.IP \fIindex\fP
Entry to be returned from the workstation's table of edge representations;
if this entry is not present in the table and the
\fItype of returned value\fP parameter is \s-2REALIZED\s+2,
the representation for edge index 1 is returned.
.IP \fItype\fP
An enumerated value specifying whether the inquired values are to be returned
as the values originally specified by the application (\s-2SET\s+2),
or as the values actually being used by the workstation
if any of the application-specified values
had to be mapped to ones available on the workstation (\s-2REALIZED\s+2).
Valid values are defined in phigs.h as:
.sp .2
.ta .3i +1.25i
.nf
	PINQ_SET	\fIReturn Application-specified Value\fP
	PINQ_REALIZED	\fIReturn Value Available on the Workstation\fP
.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 Pedge_bundle structure in which the system returns the
edge representation at \fIindex\fP in the workstation's table of 
edge representations.
Pedge_bundle is defined in phigs.h as follows:
.sp .4
.ta .5i +1i +1i
.nf
typedef struct {
.sp .2
	Pedge_flag	flag;	/* edge flag */
	Pint	type;	/* edgetype */
	Pfloat	width;	/* edgewidth 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 .2
.ta .5i
.nf
	PEDGE_OFF
	PEDGE_ON
.sp .2
.fi
.SH ERRORS
.IP 003
Ignoring function, function requires state 
(\s-2PHOP\s+2, \s-2WSOP\s+2, \s-2*\s+2, \s-2*\s+2)
.IP 054
Ignoring function, the specified workstation is not open
.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 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 "INQUIRE EDGE FACILITIES (3P)"
.SM "SET EDGE REPRESENTATION (3P)"
.SM "INQUIRE PREDEFINED EDGE REPRESENTATION (3P)"
.SM "INQUIRE EDGE REPRESENTATION PLUS (3P+)"
.fi
