graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPRISN - Retrieve Identifiers of Structures in Network

GPRISN (arid, strid, start, number, errind, totnum, istrid)

Note:

This subroutine is an Archive inquiry. For an overview, see "Archive Inquiries"

Purpose

Use GPRISN to retrieve a list of structure identifiers in a specified structure network in the specified open archive file.

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

arid -- specified by user, fullword integer

Archive file identifier.

strid -- specified by user, fullword integer

Structure identifier of the root structure.

start -- specified by user, fullword integer

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:

7: FUNCTION REQUIRES STATE AROP
122: STRUCTURE IDENTIFIER DOES NOT EXIST
220: SPECIFIED ARCHIVE FILE 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 the specified structure network.

istrid -- returned by the graPHIGS API, fullword integer

List of structure identifiers. In a complete list of structure identifiers in the network, the first structure identifier 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

GPRSTI: Retrieve Structure Identifiers

RCP code

201347598 ( X'0C00520E')