graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQACS - Inquire All Conflicting Structures in Structure Store

GPQACS (ssid, start, number, errind, totnum, istrid)

Note:

This subroutine is a Structure State List (SSL) inquiry. For an overview, see "SSL Inquiries"

Purpose

Use GPQACS to inquire a list of the structure identifiers that exist in both the currently selected structure store.

If the specified structure store identifier is the same as the currently selected structure store identifier, then this subroutine is functionally equivalent to the Inquire Structure Identifiers (GPQSTI) subroutine.

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 543 (the start value exceeds the extent of the available data), then only the total number (totnum) parameter is set. 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

ssid -- specified by user, fullword integer

Structure store identifier.

start -- specified by user, fullword integer

The starting member of the list of structure identifiers (>=1)

number -- specified by user, fullword integer

Number of entries requested (>=0)

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:

12: FUNCTION REQUIRES STATE SSSL
222: SPECIFIED STRUCTURE STORE DOES NOT EXIST
538: START VALUE < ONE
539: REQUESTED NUMBER < ZERO
543: START EXCEEDS DATA EXTENT. TOTAL NUMBER AVAILABLE RETURNED

totnum -- returned by the graPHIGS API, fullword integer

Total number of conflicting structures.

istrid -- returned by the graPHIGS API, array of fullword integers

List of conflicting structure identifiers.

Error Codes

None

Related Subroutines

GPQCSN: Inquire Conflicting Structures in Network in Structure Store
GPQSTI: Inquire Structure Identifiers

RCP code

201347590 (X'0C005206')