INQUIRE PATTERN REPRESENTATION PLUS(3P+) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

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

SYNOPSIS

C Syntax

void
pinq_pat_rep_plus (ws, index, type, store, error_ind, rep )
Pintws;workstation identifier
Pintindex;pattern index
Pinq_typetype;type of returned value
Pstorestore;OUT pointer to buffer
Pint∗error_ind;OUT error indicator
Ppat_rep_plus∗∗rep;OUT pattern representation

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

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

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 inital buffer through a call to CREATE STORE, PHIGS manages this area such 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.

wsThe workstation identifier.

indexThe pattern index.

typeAn 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;

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

repA 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_sizedims;/∗ pattern’s dimensions ∗/
Pinttype;/∗ 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.

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 (that is, 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