[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface: ISO PHIGS Subroutine Reference

INQUIRE HIGHLIGHTING FILTER (PHOP,WSOP,*,*)

Purpose

Use Inquire Highlighting Filter to inquire the current highlighting inclusion and exclusion filters on the specified workstation.

The graPHIGS API returns the inclusion filter list and the exclusion filter list.

If the information is available, then the graPHIGS API sets the error indicator to zero and returns the values in the output parameters. If the information is unavailable, then the values returned in the output parameters are unpredictable and the graPHIGS API sets the error indicator to one of the following errors:

3
Function Requires State (PHOP,WSOP,*,*)
54
Specified Workstation Is Not Open
59
Specified Workstation Does Not Have Output Capability

Language Bindings

C

pinq_highl_filter (ws_id, store, err_ind, highl_filter)

Input Parameters

Pint ws_id
Workstation identifier.

Pstore store
Handle to the store object. The graPHIGS API uses an object of type Store to facilitate the use of subroutines which return complex data. See Create Store ( CREATE STORE (PHOP,*,*,*)) subroutine for details on how the graPHIGS API uses this parameter on inquiries.

Output Parameters

Pint *err_ind
Error indicator.

Pfilter **highl_filter
Highlighting filter. The memory referenced by *highl_filter is managed by the parameter store.

FORTRAN

PQHLFT (wkid, isbsz, esbsz, errind, isn, is, esn, es)

Input Parameters

integer wkid
Workstation identifier.

integer isbsz
Inclusion set buffer size (>=0).

integer esbsz
Exclusion set buffer size (>=0).

Output Parameters

integer errind
Error indicator.

integer isn
Number of names in the inclusion set.

integer is (isbsz)
Inclusion set.

integer esn
Number of names in the exclusion set.

integer es (esbsz)
Exclusion set.

Errors

None

Related Subroutines

  • Set Highlighting Filter

  • Inquire PHIGS Facilities

    • [ Previous | Next | Contents | Glossary | Home | Search ]