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

NAME

INQUIRE PREDEFINED EXTENDED PATTERN REPRESENTATION − inquire a predefined extended pattern representation for a specified workstation type

SYNOPSIS

C Syntax

void
pinqpredextpatrep ( wstype, index, size, error_ind, buffer, total_size, rep )
Pwstypewstype;workstation type
Pintindex;predefined pattern index
Pintsize;size of application buffer
Pint∗error_ind;OUT error indicator
Pchar∗buffer;OUT pointer to buffer
Pint∗total_size;OUT actual size of buffer
Pextptbundl∗rep;OUT extended pattern representation

FORTRAN Syntax

SUBROUTINE pqpenr ( WKTYPE, INDEX, PSIZ, ERRIND, PBUF, ACTSIZ, PROWS, PCOLS,
COLMOD, IPCOLR, PCOLR )
INTEGERWKTYPEworkstation type
INTEGERINDEXpredefined pattern index
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
INTEGERIPCOLR(PROWS∗PCOLS) OUT indirect colour
REALPCOLR(3,PROWS∗PCOLS) OUT array of colour

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

INQUIRE PREDEFINED EXTENDED PATTERN REPRESENTATION inquires a predefined extended pattern representation for a specified workstation type.

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.

wstypeThe workstation type.

indexIndex of the predefined entry to be returned.

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. Note: The buffer is for use by the system. The system assigns the colour index array pointer to the memory space pointed to by buffer. The application accesses the returned information through the bundle parameter. If the buffer allocated is not large enough to hold all of the requested pattern representation, none of the information is returned, but total_size is returned with the number of bytes needed. If you call INQUIRE PREDEFINED EXTENDED PATTERN REPRESENTATION with a buffer size of zero, total size is returned with the size of the buffer that you will need to allocate. Error 2200 is returned if the buffer size is too small, but not if it is zero.

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

repA pointer to a Pextptbundl structure which returns the requested 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.

FORTRAN Input Parameters

WKTYPE
The workstation type.

INDEX
Index of the predefined entry to be returned.

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(PROWS∗PCOLS)
An integer index into the workstation colour table for the pattern colour.

PCOLR(3,PROWS∗PCOLS)
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 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 nonavailability.

Since this is an inquiry function, ERROR HANDLING is not invoked when an error is detected by this function.

ERRORS

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

051Ignoring function, this information unavailable for this workstation type

052Ignoring function, workstation type not recognized by the implementation

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

100Ignoring function, the bundle index value is less than one

102Ignoring function, the specified representation has not been predefined on this workstation

Museum