INQUIRE HIGHLIGHTING FILTER(3P) — SUNPHIGS LIBRARY

NAME

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

SYNOPSIS

C Syntax

void
pinqhilightfilter ( ws, in_len, in_st, ex_len, ex_st, error_ind, in, tot_in_len, ex, tot_ex_len )
Pintws;workstation identifier
Pintin_len;length of incl. set
Pintin_st;starting position of incl. set
Pintex_len;length of excl. set
Pintex_st;starting position of excl. set
Pint∗error_ind;OUT error indicator
Pintlst∗in;OUT incl. set
Pint∗tot_in_len;OUT length of incl. set in PHIGS
Pintlst∗ex;OUT excl. set
Pint∗tot_ex_len;OUT length of excl. set in PHIGS

FORTRAN Syntax

SUBROUTINE pqhlft ( WKID, ISBSZ, ESBSZ, ERRIND, ISN, IS, ESN, ES )
INTEGERWKIDworkstation identifier
INTEGERISBSZinclusion set buffer size
INTEGERESBSZexclusion set buffer size
INTEGERERRINDOUT error indicator
INTEGERISNOUT number of names in the inclusion set
INTEGERIS(ISBSZ)OUT inclusion set
INTEGERESNOUT number of names in the exclusion set
INTEGERES(ESBSZ)OUT exclusion set

Required PHIGS Operating States

(PHOP, WSOP, ∗, ∗)

DESCRIPTION

Purpose

Use INQUIRE HIGHLIGHTING FILTER to obtain the ‘highlighting filter’ from a specified workstation’s state list. This is the filter which 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

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

in_lenNumber of elements for which the application has allocated memory space in the list in. 0 may be specified, in order to get the total length of the filter’s inclusion set.

in_stStarting position in the filter’s inclusion set at which to begin the inquiry.

ex_lenNumber of elements for which the application has allocated memory space in the list ex. 0 may be specified, in order to get the total length of the filter’s exclusion set.

ex_stStarting position in the filter’s exclusion set at which to begin the inquiry.

C Output Parameters

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

inA pointer to a Pintlst in which the system returns the portion of the filter’s inclusion set, starting with in_st.

tot_in_len
A pointer to an integer in which to the system returns the total length of the filter’s inclusion set. This is the value required for in_len if the entire inclusion set is to be returned.

exA pointer to a Pintlst in which the system returns the portion of the filter’s exclusion set, starting with ex_st.

tot_ex_len
A pointer to an integer in which to the system returns the total length of the filter’s exclusion set. This is the value required for ex_len if the entire exclusion set is to be returned.

Pintlst is defined in phigs.h as follows:

typedef struct {
Pintnumber;/∗ number of integers ∗/
Pint∗integers;/∗ list of integers ∗/

} Pintlst; The pointer in->integers (ex->integers) must be initialized to an array of in_len (ex_len) Pint elements.

FORTRAN Input Parameters

WKIDThe workstation identifier of the workstation whose state list is queried.

ISBSZSize of the IS array in which the returned inclusion set elements will be stored. If this value is smaller than the actual number of elements in the inclusion set (ISN), no data will be returned in the IS array, but ISN will be set to indicate the array size required. If you call this function with an array size of zero, ISN is returned with the required array size. Error 2001 is returned if ISBSZ is too small, but not if it’s zero.

ESBSZ
Size of the ES array in which the returned exclusion set elements will be stored. If this value is smaller than the actual number of elements in the exclusion set (ESN), no data will be returned in the ES array, but ESN will be set to indicate the array size required. If you call this function with an array size of zero, ESN is returned with the required array size. Error 2001 is returned if ESBSZ is too small, but not if it’s zero.

FORTRAN Output Parameters

ERRIND
The error number of any error detected by this function.

ISNThe number of inclusion set elements returned in the IS array.

ISAn array of integers in which the elements of the filter’s inclusion set are returned.

ESNThe number of exclusion set elements returned in the ES array.

ESAn array of integers in which the elements of the filter’s exclusion set are returned.

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 (i.e., the workstation category is neither OUTPUT, OUTIN, nor MO)

Museum