graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQIVF - Inquire Invisibility Filter

GPQIVF (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 GPQIVF to inquire the current invisibility filter values for the visibility inclusion and exclusion filters on the specified workstation.

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

Length of inclusion filter array provided by the application for the graPHIGS API to return the corresponding filters (>=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

Length of exclusion filter array provided by the graPHIGS API to return the corresponding filter (>=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

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

Number of class names in the inclusion filter.

incl -- returned by the graPHIGS API, array of fullword integers.

List of class names in the inclusion filter.

exclen -- returned by the graPHIGS API, fullword integer

Number of class names in the exclusion filter length.

excl -- returned by the graPHIGS API, array of fullword integers.

List of class names in the exclusion filter.

Error Codes

None

Related Subroutines

GPIVF: Set Invisibility Filter
GPQNCN: Inquire Number of Available Class Names

RCP code

201336838 (X'0C002806')