.\"
.\" $XConsortium: p203,v 5.2 94/04/17 20:56:47 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 be.\"low:
.ds pN INQUIRE PREDEFINED TEXT REPRESENTATION PLUS
.TH "\*(pN" 3P+ "29 February 1991"
.SH NAME
\*(pN \- 
inquire a predefined extended text representation for a specified workstation type
.IX "Inquiry functions" "INQUIRE PREDEFINED TEXT REPRESENTATION PLUS"
.IX "PHIGS Extension Functions" "\*(pN"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_pred_text_rep_plus (type, index, error_ind, bundle)
Pint	type;	\fIworkstation type\fP
Pint	index;	\fIpredefined index\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Ptext_bundle_plus	*bundle;	\fIOUT predefined text rep\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2INQUIRE PREDEFINED TEXT REPRESENTATION PLUS\s+2 
returns the attribute values of a specified predefined entry in the
extended text bundle table of a workstation type's workstation description
table.  See \s-2SET TEXT REPRESENTATION PLUS\s+2 for a full description of the
contents of the bundle table entry and a description of the extended text bundle
table.
.SS C Input Parameters
.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 Ptext_bundle_plus structure that returns the
specified extended text representation.
Ptext_bundle_plus is defined as:
.nf
.ta .5i +\w'Ptext_prec     'u +\w'char_expan;     'u
.sp .4
typedef struct {
.sp .2
	Pint	font;	/* text font */
	Ptext_prec	prec;	/* text precision */
	Pfloat	char_expan;	/* character expansion factor */
	Pfloat	char_space;	/* character spacing */
	Pgcolr	colr;	/* text colour */
.sp .2
} Ptext_bundle_plus;
.fi
.IP
See \s-2SET TEXT 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 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 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 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 TEXT REPRESENTATION PLUS (3P+)"
.SM "INQUIRE TEXT REPRESENTATION PLUS (3P+)"
.SM "INQUIRE PREDEFINED TEXT REPRESENTATION (3P)"
.fi