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

NAME

INQUIRE EXTENDED PATTERN REPRESENTATION − inquire an extended pattern representation on a workstation

SYNOPSIS

C Syntax

void
pinqextpatrep ( wsid, index, type, size, error_ind, buffer, rep, total_size )
Pintwsid;workstation identifier
Pintindex;pattern index
Pinqtypetype;type of returned value (PSET,PREALIZED)
Pintsize;size of application buffer
Pint∗error_ind;OUT error indicator
Pchar∗buffer;OUT pointer to buffer
Pextptbundl∗rep;OUT extended pattern representation
Pint∗total_size;OUT actual size of buffer

FORTRAN Syntax

SUBROUTINE pqepr ( WKID, INDEX, ITYPE, PSIZ, ERRIND, PBUF, ACTSIZ, PROWS, PCOLS,
COLMOD, IPCOLR, PCOLR )
INTEGERWKIDworkstation identifier
INTEGERINDEXpattern index
INTEGERITYPEtype of returned values (PSET,PREALI)
INTEGERPSIZbuffer size dimension
INTEGERERRINDOUT error indicator
CHARACTER∗80(∗)PBUF(PSIZ) OUT pattern buffer
INTEGERACTSIZOUT actual buffer size
INTEGERPROWSOUT pattern dimensions along y-axis
INTEGERPCOLSOUT pattern dimensions along x-axis
INTEGERCOLMODOUT colour model
INTEGERIPCOLROUT indirect colour
REALPCOLR(3)OUT array of colour

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE EXTENDED PATTERN REPRESENTATION inquires an extended pattern 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 pattern 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;

sizeThe size, in number of bytes, of the application supplied buffer in which the requested pattern representation will be stored.

C Output Parameters

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

bufferA pointer to the buffer in which the requested pattern representation is to be returned.

repA pointer to a Pextptbundl structure which returns the specified extended pattern representation. Pextptbundl is defined as:

typedef struct {
Pdimdim;/∗ pattern’s dimensions ∗/
Pinttype;/∗ colour model ∗/
Pcoval∗array;/∗ array of colours ∗/
} Pextptbundl;

See SET EXTENDED PATTERN REPRESENTATION for a full description of the contents of this structure.

total_size
A pointer to the location to store the actual size of the buffer needed to return all the information requested.

FORTRAN Input Parameters

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

WKIDThe identifier of the workstation for which the extended pattern representation is being inquired.

INDEX
The index into the specified workstation pattern 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

PSIZThe size, in number of bytes, of the application supplied buffer in which the requested pattern representation will be stored.

FORTRAN Output Parameters

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

PBUFA character array in which to return the requested pattern representation.

ACTSIZ
The actual size, in bytes, filled in the pattern buffer PBUF.

PROWS
The pattern dimensions along the y axis.

PCOLS
The pattern dimensions along the x axis.

COLMOD
The colour model.

IPCOLR
An integer containing the index into the workstation colour table for the pattern colour.

PCOLR(3)
An array of reals containing the pattern colour.

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 pattern index is not present in the pattern bundle table on the workstation and the specified type of returned value is Realized, the representation for pattern 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 non-availability.

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)

101Ignoring function, the specified representation has not been defined

109Ignoring function, interior style PATTERN is not supported on the workstation

112Ignoring function, the pattern index value is less than one

Museum