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

NAME

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

SYNOPSIS

C Syntax

void
pinq_pred_pat_rep ( type, index, store, error_ind, rep )
Pinttype;workstation type
Pintindex;predefined index
Pstorestore;handle to Store object
Pint∗error_ind;OUT error indicator
Ppat_rep∗∗rep;OUT predefined pattern rep

Required PHIGS Operating States

(PHOP, ∗, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE PREDEFINED PATTERN REPRESENTATION to determine the predefined pattern representation for a specified workstation type at a given pattern index.

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.

type
Workstation type.

index
Entry to be returned from the workstation table of predefined pattern representations.

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.

repA pointer to a pointer to a Ppat_rep structure in which the system returns the pattern representation at index in the workstation table of predefined pattern representations. Ppat_rep is defined in phigs.h as:

typedef struct {
Pint_sizedims;/∗ pattern’s dimensions ∗/
Pint∗colr_array;/∗ colour index array ∗
} Ppat_rep;

The Pint_size structure used to define the pattern dimensions is defined in phigs.h as:

typedef struct {
Pintsize_x;/∗ dimension (number of divisions) along X ∗/
Pintsize_y;/∗ dimension (number of divisions) along Y ∗/
} Pint_size;

The colr_array component of Ppat_rep is a pointer to an array of the colour indices defining the pattern of the dimensions defined by the dims component.

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 below 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 is not yet available for this workstation type; open a workstation of this type and use the specific workstation type

052Ignoring function, workstation type not recognized by the implementation

059Ignoring function, the specified workstation does not have output capability (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

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

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

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

Museum