ESCAPE -8(3P) — SUNPHIGS LIBRARY

NAME

ESCAPE -8 − inquire fonts available for a character set

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, ∗, ∗, ∗)

DESCRIPTION

Purpose

ESCAPE -8 returns a list of fonts and precisions supported for the specified character set on the specified workstation type.

C Input Parameters

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

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

typedef struct {
Pwstypetype;/∗ workstation type ∗/
Pintcharset;/∗ character set for which to get font information ∗/
Pintlength;/∗ length of application list ∗/
Pintstart;/∗ starting position ∗/
} Puesc0008_idatarec;

typeWorkstation type.

charset
The character set for which the the font information is desired.

lengthThe length of the list of fps (font and precision) items to return in the application allocated array, facilities.fps in the output data record. A length of zero may be specified, in order to have the total_length field (in the output record) return the total number of elements in the workstation list of available font and precision pairs.

startThe first element of the list of font and precision pairs in the workstation description table to return.

C Output Parameters

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

typedef struct {
Pinterror_ind;/∗ error indicator ∗/
Pinttotal_length;/∗ length of list in PHIGS ∗/
Pftfacfacilities;/∗ list of available character sets ∗/
} Puesc0008_odatarec;

error_ind
An integer in which the system returns the error number of any error detected by this function.

total_length
An integer in which the system returns the total number of items in the list of available font and precision pairs in the workstation description table. This is the value required for length if all the items in the workstation list are to be returned.

facilities
A Pftfac data structure in which the system returns a listing of the text fonts and precisions available for the specified character set on this type of workstation. Pftfac is defined in phigs.h as:

typedef struct {
Pintn_fps;/∗ number of fonts and precisions ∗/
Ptxfp∗fps;/∗ list of fonts and precisions ∗/
} Pftfac;

Ptxfp is defined in phigs.h as:

typedef struct {
Pintfont;/∗ text font ∗/
Ptxprecprecision;/∗ text precision ∗/
} Ptxfp;

Ptxprec is defined in phigs.h as:

typedef enum {
PPSTRING,
PPCHAR,
PPSTROKE,
} Ptxprec;

The application must allocate memory for the facilities.fps list.

FORTRAN Input Parameters

FCTID
The function identifier of this escape is PUESCINQFTCS, which is defined in phigs77.h to be -8.

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

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

ILThe number of integers = 3.

IAContains three integer values:

Element 1 is the workstation type.

Element 2 is the character set for which the facilities information is desired.

Element 3 is the index of the font and precision list element desired.

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. When the output record is passed to UNPACK DATA RECORD the following fields should be returned:

ILThe number of integers = 4.

IAContains four integer values:

Element 1 is the error indicator.

Element 2 is the length of the list of fonts and precisions.

Element 3 is the Nth element of the font list, as specified by element 2 in the input data record.

Element 4 is the Nth element of the precision list.

RLThe number of real values = 0.

SLThe number of strings = 0.

Execution

The Inquire Extended Fonts escape returns a list of the fonts and precisions available for the specified character set on the specified workstation type. See INTRO_INTERNATIONALIZATION (7P) for information on character sets and fonts.

ERRORS

-155Specified character set is invalid.

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

052Ignoring function, workstation type not recognized by the implementation

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

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

Museum