[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]
The graPHIGS Programming Interface : Subroutine Reference
GPQHLF - Inquire Highlighting Filter
| GPQHLF
(wsid,
inlen,
exlen,
errind,
inclen,
incl,
exclen,
excl) |
Note:
This subroutine is a Workstation State List (WSL)
inquiry.
For an overview, see
"WSL Inquiries"
Purpose
Use
GPQHLF to inquire the current highlighting
inclusion and exclusion filters on the specified
workstation.
The graPHIGS API returns the size of the inclusion filter and
its contents and the size of the exclusion filter and its
contents.
If the inquired information is available, then the graPHIGS API
sets the error indicator to zero and returns the values in
the output parameters.
If the error indicator is
533 (an output parameter is
not large enough for all the requested data), then the
values up to the length specified are returned.
If the inquired information is unavailable, then the error
indicator (errind) contains an error number indicating the
reason, and the values returned in the output parameters are
unpredictable.
Parameters
wsid -- specified by user, fullword integer
Workstation identifier.
inlen -- specified by user, fullword integer
Size of inclusion filter output array,
specified in fullword integers (>=0)
This is the size of the array provided by the application
for the graPHIGS API to return the corresponding data.
exlen -- specified by user, fullword integer
Size of exclusion filter output array,
specified in fullword integers (>=0)
This is the size of the array provided by the application
for the graPHIGS API to return the corresponding data.
errind -- returned by the graPHIGS API,
fullword integer
Error indicator. If the error indicator is zero, the request has been
completed. Otherwise, one of the following errors exists:
- 25
- SPECIFIED WORKSTATION DOES NOT EXIST
- 35
- WORKSTATION HAS ONLY INPUT CAPABILITIES
- 505
- LENGTH OF RETURN ARRAY < ZERO
- 533
- INQUIRY DATA EXCEEDS AREA. OUTPUT TRUNCATED
inclen -- returned by the graPHIGS API, fullword integer
Returned inclusion filter size.
incl -- returned by the graPHIGS API, array of fullword
integers.
Inclusion filter.
List of class names.
exclen -- returned by the graPHIGS API, fullword integer
Returned exclusion filter size.
excl -- returned by the graPHIGS API, array of fullword
integers.
Exclusion filter.
List of class names.
Error Codes
None
Related Subroutines
- GPHLF
- Set Highlighting Filter
- GPQNCN
- Inquire Number of Available Class Names
RCP code
201336837
(X'0C002805')
[ Previous |
Next |
Contents |
Glossary |
Home |
Search ]