ESCAPE -15(3P) — SUNPHIGS LIBRARY

NAME

ESCAPE -15 − specify the type of archive

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 -15 allows the selection of the format of archive files.

C Input Parameters

func_id
The function identifier for this escape is PUESC_SET_ARCHIVE_TYPE, defined in phigs.h to have the value -15.

in
A pointer to a Pescapein union containing the input data record required by this escape function. It is defined as:

typedef struct {
Phigs_archive_mode archive_mode;
} Puesc0015_idatarec;

The valid values for archive_mode are defined in phigs.h as:

PHIGS_AR_CLEAR_TEXTWrite archive in clear text format
PHIGS_AR_PRIVATE Write archive in private binary format

C Output Parameters

There is no output data record for this ESCAPE.

FORTRAN Input Parameters

FCTID
The function identifier for this escape is PUESCSETARMODE, defined in phigs.h to have the value -15.

LIDR
The dimension of the input data record array, IDR, (returned by PACK DATA RECORD). ERROR HANDLING will be invoked if the specified dimension is less than zero.

IDR
An ESCAPE input data record packed by PACK DATA RECORD containing the input data for this escape. The arguments to PACK DATA RECORD should be as follows:

ILThe number of integers = 1.

IAContains one integer value, specifying the archive mode. The valid values are:

PARMODECLRWrite archive in clear text format
PARMODEPRV Write archive in private binary format

RLThe number of real values = 0.

SLThe number of strings = 0.

FORTRAN Output Parameters

There is no output data record for this ESCAPE.

Execution

The Archive Mode escape provides control over the format of archive files written. Two formats of archive files are supported: clear text format and a private binary format. The binary format is supported for backward compatability with previous SunPHIGS releases and for users who want compact archives over standard conformance.

ERRORS

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

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

Museum