graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQEXS - Inquire Executed Structures

GPQEXS (strid, start, number, errind, totnum, lstrid)

Note:

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

Purpose

Use GPQEXS to inquire the list of structure identifiers that exist in execute structure-type elements (execute structure elements and conditional execute structure elements) within the specified structure of the currently selected structure store.

If the inquired information is available, the error indicator is returned as zero, and the values are returned 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 parameter is set. If the inquired information is unavailable, the error indicator contains an error number indicating the reason, and the values returned in the output parameters are unpredictable.

Parameters

strid -- specified by user, fullword integer

Structure identifier.

start -- specified by user, fullword integer

Starting member of the list of structure identifier (>=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
122: STRUCTURE IDENTIFIER 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 structure identifiers contained in the execute structure elements in the specified structure.

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

List of structure identifiers.

Error Codes

None

Related Subroutines

GPEXST: Execute Structure
GPCEXS: Conditional Execute Structure
GPQRST: Inquire Referencing Structures

RCP code

201337093 (X'0C002905')