INQUIRE TEXT REPRESENTATION(3P) — SUNPHIGS LIBRARY

NAME

INQUIRE TEXT REPRESENTATION − inquire a text representation on a workstation

SYNOPSIS

C Syntax

void
pinqtextrep ( ws, index, type, error_ind, rep )
Pintws;workstation identifier
Pintindex;text index
Pinqtypetype;type of returned value
Pint∗error_ind;OUT error indicator
Ptxbundl∗rep;OUT text representation

FORTRAN Syntax

SUBROUTINE pqtxr ( WKID, TXI, TYPE, ERRIND, FONT, PREC, CHXP, CHSP, COLI )
INTEGERWKIDworkstation identifier
INTEGERTXItext index
INTEGERTYPEtype of returned values (PSET, PREALI)
INTEGERERRINDOUT error indicator
INTEGERFONTOUT text font
INTEGERPRECOUT text precision (PSTRP, PCHARP, PSTRKP)
REALCHXPOUT character expansion factor
REALCHSPOUT character spacing
INTEGERCOLIOUT text colour index

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE TEXT REPRESENTATION to determine the current attribute values for a specified entry in a specified workstation’s table of defined text representations.

See the description of the subroutine SET TEXT REPRESENTATION for information on the meaning of these attribute values.

C Input Parameters

wsWorkstation identifier.

indexEntry to be returned from the workstation’s table of text representations; if this entry is not present in the table and the type of returned value parameter is REALIZED, the representation for text index 1 is returned.

typeAn enumerated value specifying whether the inquired values are to be returned as the values originally specified by the application (SET), 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 (REALIZED). Valid values are defined in phigs.h as:

PSET(return application-specified value)
PREALIZED(return value available on the workstation)

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 Ptxbundl structure in which the system returns the text representation at index in the workstation’s table of text representations. Ptxbundl is defined in phigs.h as follows:

typedef struct {
Pintfont;/∗ text font ∗/
Ptxprecprecision;/∗ text precision ∗/
Pfloatexp;/∗ character expansion factor ∗/
Pfloatspace;/∗ character spacing ∗/
Pintcolour;/∗ text colour index ∗/
} Ptxbundl;

FORTRAN Input Parameters

WKIDWorkstation identifier.

TXIEntry to be returned from the workstation’s table of text representations; if this entry is not present in the table and the type of returned value parameter is REALIZED, the representation for text index 1 is returned.

TYPEAn enumerated value specifying whether the inquired values are to be returned as the values originally specified by the application (SET), 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 (REALIZED). Valid values are defined in phigs.h as:

PSET(return application-specified value)
PREALI(return value available on the workstation)

FORTRAN Output Parameters

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

FONTThe text font at index TXI in the workstation’s table of text representations.

PRECThe text precision at index TXI in the workstation’s table of text representations.

CHXPThe character expansion factor at index TXI in the workstation’s table of text representations.

CHSPThe character spacing at index TXI in the workstation’s table of text representations.

COLIThe text colour index at index TXI in the workstation’s table of text representations.

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