graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPRSTI - Retrieve Structure Identifiers

GPRSTI (arid, start, number, errind, totnum, istrid)

Note:

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

Purpose

Use GPRSTI to retrieve a list of structure identifiers 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.

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
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 archive file.

istrid -- returned by the graPHIGS API, fullword integer

List of structure identifiers.

Error Codes

None

Related Subroutines

None

RCP code

201347598 ( X'0C00520E')