.\"##
.\" $XConsortium: p218,v 5.2 94/04/17 20:56:58 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 TEXT REPRESENTATION" 3P "29 February 1991"
.SH NAME
INQUIRE TEXT REPRESENTATION \- inquire a text representation on a workstation
.IX "Attribute Representations" "INQUIRE TEXT REPRESENTATION"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
pinq_text_rep ( ws, index, type, error_ind, rep )
Pint	ws;	\fIworkstation identifier\fP
Pint	index;	\fItext index\fP
Pinq_type	type;	\fItype of returned value\fP
Pint	*error_ind;	\fIOUT error indicator\fP
Ptext_bundle	*rep;	\fIOUT text representation\fP
.fi
.ft R
.SS Required PHIGS Operating States
(PHOP, WSOP, *, *)
.SH DESCRIPTION
.SS Purpose
Use \s-2INQUIRE TEXT REPRESENTATION\s+2 to determine the current attribute
values for a specified entry in a specified workstation's table of
defined text representations.
.SS C Input Parameters
.IP \fIws\fP
Workstation identifier.
.IP \fIindex\fP
Entry to be returned from the workstation's table of text 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 text 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:
.ta .5i +1.25i
.nf
.sp .4
typedef enum {
.sp .2
	PINQ_SET,	/* Return Application-specified Value */
	PINQ_REALIZED	/* Return Value Available on the Workstation */
.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 Ptext_bundle structure in which the system returns the
text representation at \fIindex\fP in the workstation's table of 
text representations.
Ptext_bundle is defined in phigs.h as follows:
.sp .4
.ta .5i +1.0i +1.0i
.nf
typedef struct {
.sp .2
	Pint	font;	/* text font */
	Ptext_prec	prec;	/* text precision */
	Pfloat	char_expan;	/* character expansion factor */
	Pfloat	char_space;	/* character spacing */
	Pint	colr_ind;	/* text colour index */
.sp .2
} Ptext_bundle;
.fi
.IP
Ptext_prec is defined in phigs.h as:
.sp .4
.ta .5i +\w'PPSTRING,     'u +\w'character precision     'u
.nf
typedef enum {
.sp .2
	PPREC_STRING,
	PPREC_CHAR,
	PPREC_STROKE
.sp .2
} Ptext_prec;
.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 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 PREDEFINED TEXT REPRESENTATION (3P)"
.SM "SET TEXT REPRESENTATION (3P)"
.SM "INQUIRE LIST OF TEXT INDICES (3P)"
.SM "INQUIRE TEXT REPRESENTATION PLUS (3P+)"
.fi