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

NAME

INQUIRE EXTENDED TEXT REPRESENTATION − inquire an extended text representation on a workstation

SYNOPSIS

C Syntax

void
pinqexttextrep ( wsid, index, type, error_ind, rep )
Pintwsid;workstation identifier
Pintindex;text index
Pinqtypetype;type of returned value (PSET,PREALIZED)
Pint∗error_ind;OUT error indicator
Pexttxbundl∗rep;OUT extended text representation

FORTRAN Syntax

SUBROUTINE pqetr ( WKID, INDEX, ITYPE, ERRIND, TFONT, TPREC, TCEXPF, TSPACE,
COLMOD, ITCOLR, TCOLR )
INTEGERWKIDworkstation identifier
INTEGERINDEXtext bundle index
INTEGERITYPEtype of returned values (PSET,PREALI)
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, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE EXTENDED TEXT REPRESENTATION inquires an extended text representation on a workstation.

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.

wsidThe workstation identifier.

indexThe text index.

typeAn enumerated value specifying whether the values to be returned are those originally specified by the application (PSET), or those resulting after PHIGS mapped them to ones available on the workstation (PREALIZED). A Pinqtype structure is defined as:

typedef enum {
PSET,
PREALIZED
} Pinqtype;

C Output Parameters

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

repA 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

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

WKIDThe identifier of the workstation for which the text representation is being defined.

INDEX
The index into the specified workstation text bundle table.

ITYPE
An enumerated value specifying whether the values to be returned are those originally specified by the application (Set), or those resulting after PHIGS mapped them to ones available on the workstation (Realized). Valid values are:

0PSETSet
1PREALIRealized

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 value containing the index into the workstation colour table for determining 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 specified text index is not present in the text bundle table on the workstation and the specified type of returned value is Realized, the representation for text index one is returned.

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

003Ignoring function, function requires state (PHOP, WSOP, ∗, ∗)

054Ignoring function, the specified workstation is not open

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

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

101Ignoring function, the specified representation has not been defined

Museum