INQUIRE PREDEFINED EXTENDED TEXT REPRESENTATION(3P+) — MISC. REFERENCE MANUAL PAGES

NAME

INQUIRE PREDEFINED EXTENDED TEXT REPRESENTATION − inquire a predefined extended text representation for a specified workstation type

SYNOPSIS

C Syntax

void
pinqpredexttextrep (wstype, index, error_ind, bundle)
Pwstypewstype;workstation type
Pintindex;predefined text index
Pint∗error_ind;OUT error indicator
Pexttxbundl∗bundle;OUT predefined text representation

FORTRAN Syntax

SUBROUTINE pqpetr ( WKTYPE, INDEX, ERRIND, TFONT, TPREC, TCEXPF, TSPACE,
COLMOD, ITCOLR, TCOLR )
INTEGERWKTYPEworkstation type
INTEGERINDEXpredefined text index
INTEGERERRINDOUT error indicator
INTEGERTFONTOUT text font
INTEGERTPRECOUT text precision
REALTCEXPFOUT text character expansion factor
REALTSPACEOUT text character spacing
INTEGERCOLMODOUT colour model
INTEGERITCOLROUT indirect colour index
REALTCOLR(3)OUT direct colour value

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED EXTENDED TEXT REPRESENTATION inquires a predefined extended text representation for a specified workstation type.

This is a SunPHIGS Extension function based on PHIGS+ and is not part of the PHIGS standard.

C Input Parameters

All of the following data types are predefined in phigs.h.

wstypeThe workstation type.

indexIndex of the predefined entry to be returned.

C Output Parameters

error_ind
A pointer to the location to store the error number of any error detected by this function.

bundleA pointer to a Pexttxbundl structure which returns the specified extended text representation. Pexttxbundl is defined as:

typedef struct {
Pintfont;/∗ text font ∗/
Ptxprecprecision;/∗ text precision ∗/
Pfloatexp;/∗ character expansion factor ∗/
Pfloatspace;/∗ character spacing ∗/
Pgcolrcolour;/∗ text colour ∗/
} Pexttxbundl;

See SET EXTENDED TEXT REPRESENTATION for a full description of the contents of this structure.

FORTRAN Input Parameters

WKTYPE
The workstation type.

INDEX
Index of the predefined entry to be returned.

FORTRAN Output Parameters

ERRIND
The error number of any error detected by this function.

TFONT
The text font.

TPREC
The text precision.

TCEXPF
The text character expansion factor.

TSPACE
The text character spacing.

COLMOD
The colour model. The predefined values are:

0PINDIRColour Index Specified
1PRGBRed, Green, and Blue
2PCIECIE Colour Model
3PHSVHue, Saturation, and Value
4PHLSHue, Lightness, and Saturation

ITCOLR
An integer containing the index into the workstation colour table for the text colour. This value is not used if COLMOD is greater than zero.

TCOLR(3)
An array of reals containing the text colour. This array is unused if COLMOD is equal to zero (PINDIR).

TCOLR(1) = Red, Hue, etc.
TCOLR(2) = Green, Saturation, Lightness, etc.
TCOLR(3) = Blue, Value, Saturation, etc.

Execution

If the inquired information is available, the error indicator is returned as zero and values are returned in the output parameters.

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.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

002Ignoring function, function requires state (PHOP, ∗, ∗, ∗)

051Ignoring function, this information unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

062Ignoring function, this information is not available for this MO workstation type

100Ignoring function, the bundle index value is less than one

102Ignoring function, the specified representation has not been predefined on this workstation

Museum