ESCAPE -11(3P) — SUNPHIGS LIBRARY

NAME

ESCAPE -11 − inquire extended text representation fonts

SYNOPSIS

C Syntax

void
pescape ( func_id, in, out )
Pintfunc_id;escape function identifier
Pescapein∗in;input data for the function
Pescapeout∗out;OUT output data of the function

FORTRAN Syntax

SUBROUTINE pesc ( FCTID, LIDR, IDR, MLODR, LODR, ODR )
INTEGERFCTIDfunction identification
INTEGERLIDRdimension of input data record array
CHARACTER∗80IDR(LIDR) input data record
INTEGERMLODRmaximum length of output data record
INTEGERLODROUT number of array elements used in ODR
CHARACTER∗80ODR(MLODR) OUT output data record

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

ESCAPE -11 returns the fonts for codesets 1 through 3 of the extended text representation.

C Input Parameters

func_id
The function identifier for this escape is PUESC_INQ_EXT_TEXT_REP_FONTS which is defined in phigs.h to be -11.

in
A pointer to a Pescapein union containing the input data record uesc11_idatarec. It is defined as follows:

typedef struct {
Pintws;/∗ workstation identifier ∗/
Pintindex;/∗ text bundle index ∗/
Pinqtypetype;/∗ type of returned value ∗/
} Puesc0011_idatarec;

This fields in this record correspond to the input parameters to INQUIRE TEXT REPRESENTATION.

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

indexThe text index of the entry being inquired.

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:

PSETReturn Application-specified Value
PREALIZEDReturn Value Available on the Workstation

C Output Parameters

outA pointer to a Pescapeout union containing the output data record, uesc11_odatarec. It is defined as follows:

typedef struct {
Pinterror_ind;/∗ error indicator ∗/
Pefbundlrep;/∗ extended fonts text representation ∗/
} Puesc0011_odatarec;

The fields in this record correspond to the output parameters to INQUIRE TEXT REPRESENTATION except that a different part of the representation is being returned.

error_ind
The error indicator. See the Errors section below for possible values.

repA structure containing the attribute values defining the multiple text representation, defined as follows:

typedef struct {
Pintfont[3];/∗ Fonts for codesets 1 to 3 ∗/
} Pefbundl;

FORTRAN Input Parameters

FCTID
The function identifier of this escape is PUESCINQXTXREPFT which is defined in phigs77.h to be -11.

LIDR
The dimension of IDR (returned by PACK DATA RECORD).

IDR(LIDR)
An ESCAPE data record packed by PACK DATA RECORD called with these arguments:

ILThe number of integers = 3.

IAContains three integer values.

Element 1 is the workstation identifier.

Element 2 is the text bundle index

Element 3 is the type of the values to be returned. It is an 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 phigs77.h as:

PSETReturn Application-specified Value
PREALIReturn Value Available on the Workstation

RLThe number of real values = 0.

SLThe number of strings = 0.

MLODR
The maximum length of the output data record, ODR.

FORTRAN Output Parameters

LODRThe length used in the output data record array, ODR.

ODR(MLODR)
The output data record is stored in this array. It may unpacked using UNPACK DATA RECORD, the resulting fields should be returned:

ILThe number of integers = 3.

IAContains three integer values.

Elements 1 through 3 are the fonts for codesets 1 through 3.

RLThe number of real values = 0.

SLThe number of strings = 0.

Execution

The Inquire Extended Text Representation Fonts escape returns the extended fonts section of an extended text representation. The complete text representation has the following fields:

font for codeset 0font in the normal text representation
font for codeset 1an internationalization extension
font for codeset 2an internationalization extension
font for codeset 3an internationalization extension
text precision
character expansion factor
character spacing
color index

This escape returns the extended fonts section of this representation. The other values can be inquired using INQUIRE TEXT REPRESENTATION.

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

351Ignoring function, one of the fields within the escape data record is in error

Museum