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

GPQRST - Inquire Referencing Structures

GPQRST (strid, start, number, errind, totnum, istrid)

Note:

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

Purpose

Use GPQRST to inquire a list of identifiers of structures that contain execute structure-type elements (execute structure elements and conditional execute structure elements) that reference the specified structure.

A structure identifier can be in the list once for every execute structure-type element that it contains that references the specified structure.

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

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
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 referencing structures.

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

List of structure identifiers that reference the specified structure.

Error Codes

None

Related Subroutines

GPQEXS
Inquire Executed Structures

RCP code

201337102 ( X'0C00290E')


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