NAME

INQUIRE PATTERN REPRESENTATION PLUS - inquire for extended pattern representation on workstation

C Syntax

void

pinq_pat_rep_plus (ws, index, type, store, error_ind, rep )

Pint             ws;           workstation identifier
Pint             index;        pattern index
Pinq_type        type;         type of returned value
Pstore           store;        OUT pointer to buffer
Pint             * error_ind;  OUT error indicator
Ppat_rep_plus    ** rep;       OUT pattern representation

FORTRAN Syntax

SUBROUTINE pqepr ( WKID, INDEX, ITYPE, PSIZ, ERRIND, PBUF, ACTSIZ, PROWS, PCOLS, COLMOD, IPCOLR, PCOLR )

INTEGER             WKID            workstation identifier
INTEGER             INDEX           pattern index
INTEGER             ITYPE           type of returned values (PSET, PREALI )
INTEGER             PSIZ            buffer size dimension
INTEGER             ERRIND          OUT error indicator
CHARACTER* 80       PBUF(PSIZ)      OUT pattern buffer
INTEGER             ACTSIZ          OUT actual buffer size
INTEGER             PROWS           OUT pattern dimensions along y-axis
INTEGER             PCOLS           OUT pattern dimensions along x-axis
INTEGER             COLMOD          OUT colour model
INTEGER             IPCOLR          OUT indirect colour
REAL                PCOLR(3)        OUT array of colour

Required PHIGS Operating States

(PHOP, WSOP, * ,* )

DESCRIPTION

Purpose

INQUIRE PATTERN REPRESENTATION PLUS inquires for an extended pattern representation on a workstation.

This is a SunPHIGS Extension function based on PHIGS PLUS and is not part of the PHIGS standard.

C Input Parameters

Applications using the C binding must create a buffer to be used by this function as memory space for storing data associated with the device state. This buffer is passed as the store argument.

The store buffer is a data area managed by PHIGS. While the application is responsible for creating the initial buffer through a call to CREATE STORE, PHIGS manages this area so that there is sufficient memory for the specific inquiry. The data record within the store buffer is accessed by the pointer pointed to by rep.

ws

The workstation identifier.

index

The pattern index.

type

An enumerated value specifying whether the values to be returned are those originally specified by the application (PINQ_SET), or those resulting after PHIGS mapped them to ones available on the workstation (PINQ_REALIZED). A Pinq_type structure is defined as:

typedef enum {

PINQ_SET,

PINQ_REALIZED

} Pinqtype;

store

The memory buffer PHIGS is to use for storing the information returned. This buffer must exist prior to calling this function (see CREATE STORE (3P)).

C Output Parameters

error_ind

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

rep

A pointer to a pointer to a Ppat_rep_plus structure, which returns the specified extended pattern representation. Ppat_rep_plus is defined as:

typedef struct {

Pint_size  dims;          /* pattern's dimensions * /
Pint       type;          /* colour model * /
Pcoval     * colr_array;  /* array of colours * /

} Ppat_rep_plus;

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

FORTRAN Input Parameters

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

WKID

The 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:

                0   PSET      Set
                1   PREALI    Realized

PSIZ

The 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.

PBUF

A 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, then 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

003

Ignoring function, function requires state (PHOP, WSOP, * ,* )

054

Ignoring function, the specified workstation is not open

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT, OUTIN, or MO)

101

Ignoring function, the specified representation has not been defined

109

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

112

Ignoring function, the pattern index value is less than one

SEE ALSO

SET PATTERN REPRESENTATION PLUS (3PP)

INQUIRE PATTERN REPRESENTATION (3P)

INQUIRE PREDEFINED PATTERN REPRESENTATION PLUS (3PP)