graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQISN - Inquire Identifiers of Structures in Network

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

Note:

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

Purpose

Use GPQISN to inquire a list of the structure identifiers in the specified structure network.

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

strid -- specified by user, fullword integer

Structure identifier of the root structure.

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 structures in network.

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

List of conflicting structure identifiers. In a complete list of structure identifiers in the network, the first structure identifier entry is always the root structure. No structure identifiers are duplicated in the list (e.g., if a structure is referenced in the network more than once, then it only appears once in the list)

Error Codes

None

Related Subroutines

GPQSTE: Inquire Structure Existence
GPQSTI: Inquire Structure Identifiers

RCP code

201347589 (X'0C005205')