.\"
.\" $XConsortium: p186,v 5.2 94/04/17 20:56:35 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.
.\" 1. Substitute PHIGS Extension function name (in CAPS) for "PNAME" in line below:
.ds pN INQUIRE POLYMARKER REPRESENTATION PLUS
.TH "\*(pN" 3P+ "29 February 1991"
.SH NAME
\*(pN \- 
inquire an extended polymarker representation on a workstation
.IX "Attribute Representations" "INQUIRE POLYMARKER REPRESENTATION PLUS"
.IX "Inquiry functions" "INQUIRE POLYMARKER REPRESENTATION PLUS"
.IX "PHIGS Extension Functions" "\*(pN"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.5i 3i
.nf
.\" 6. Insert C syntax below
void 
pinq_marker_rep_plus ( wsid, index, type, error_ind, rep )
Pint	wsid;	\fIworkstation identifier\fP
Pint	index;	\fIpolymarker index\fP
Pinq_type	type;	\fItype of returned value\fP 
Pint	*error_ind;	\fIOUT error indicator\fP
Pmarker_bundle_plus	*rep;	\fIOUT polymarker representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE POLYMARKER REPRESENTATION PLUS\s+2 
returns the
attribute values of a specified entry in a workstation
extended polymarker bundle table.
See \s-2SET POLYMARKER REPRESENTATION PLUS\s+2 for a full description
of the contents of the bundle table entry and a description of the extended
polymarker bundle table.
.SS C Input Parameters
.IP \fIwsid\fP
Workstation identifier.
.IP \fIindex\fP
Index of the entry to be returned from the workstation extended polymarker
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 polymarker 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 Pmarker_bundle_plus structure which returns the
specified extended polymarker representation.
Pmarker_bundle_plus is defined as:
.nf
.ta .5i +\w'Pgcolr     'u +\w'colour;     'u
.sp .4
typedef struct {
.sp .2
	Pint	type;	/* marker type */
	Pfloat	size;	/* marker size scale factor */
	Pgcolr	colr;	/* marker colour */
.sp .2
} Pmarker_bundle_plus;
.fi
.IP
.bp
Pgcolr is defined as:
.ta .5i +.5i +.5i  +.5i
.nf
.sp .4
typedef struct {
.sp .2
	Pint	type;	/* indirect, RGB, CIE, HSV, HLS */
	union {
	     Pint	ind;	/* index in workstation colour bundle table */
	     struct {
	          Pfloat	x;	/* red, hue, etc. */
	          Pfloat	y;	/* green, saturation, lightness, etc. */
	          Pfloat	z;	/* blue, value, saturation, etc. */
	     } general;
	} val;
} Pgcolr;
.fi
.IP
.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 specified polymarker index is not present in the polymarker
bundle table on the workstation and the specified type of returned
value is \fIRealized\fP, the representation for polymarker 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 following 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 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 POLYMARKER REPRESENTATION PLUS (3P+)"
.SM "INQUIRE POLYMARKER REPRESENTATION (3P)"
.SM "INQUIRE PREDEFINED POLYMARKER REPRESENTATION PLUS (3P+)"
.fi
