INQUIRE HIGHLIGHTING FILTER(3P) — Kubota Pacfic Computer Inc. (29 February 1991)

NAME

INQUIRE HIGHLIGHTING FILTER − inquire inclusion and exclusion name sets for a workstation’s highlighting filter

SYNOPSIS

C Syntax

void
pinq_highl_filter ( ws, store, error_ind, highl_filter )
Pintws;workstation identifier
Pstorestore;handle to Store object
Pint∗error_ind;OUT error indicator
Pfilter∗∗highl_filter;OUT highlighting filter

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE HIGHLIGHTING FILTER to obtain the highlighting filter from a specified PHIGS workstation state list. This is the filter that is compared to the traversal-time current name set of each primitive to determine if the primitive is highlighted.

The filter contains an inclusion set and an exclusion set of names. During traversal, a primitive is eligible for highlighting if at least one name in the current name set is in the inclusion set and no name in the current name set is in the exclusion set. Each name in the name set, inclusion set, and exclusion set is a small positive integer.

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

wsThe workstation identifier of the workstation whose highlighting filter is to be returned.

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.

highl_filter
A pointer to a pointer to a list of highlighting filters. Pfilter is defined in phigs.h as follows:

typedef struct {
Pint_listincl_set;/∗ inclusion set ∗/
Pint_listexcl_set;/∗ exclusion set ∗/
} Pfilter;

Pint_list is defined in phigs.h as follows:

typedef struct {
Pintnum_ints;/∗ number of Pints in list ∗/
Pint∗ints;/∗ list of integers ∗/
} Pint_list;

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 (in other words, the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum