graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQATR - Inquire List of Attached Resources

GPQATR (ncid, type, start, number, errind, totnum, id)

Note:

This subroutine is a graPHIGS API State List (PSL) inquiry. For an overview, see "PSL Inquiries"

Purpose

Use GPQATR to inquire the list of resources of the specified type in the specified nucleus that are attached to the shell.

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.

Note:

The Inquire Set of Open Workstations (GPQOPW) subroutine is treated as a special form of this generic subroutine. It inquires the set of workstation resources in the nucleus with an identifier of 1.

Parameters

ncid -- specified by user, fullword integer

Nucleus identifier.

type -- specified by user, fullword integer

Resource type (1=WORKSTATION, 2=STRUCTURE_STORE, 3=IMAGE_BOARD, 4=FONT_DIRECTORY, 5=ARCHIVE_FILE )

start -- specified by user, fullword integer

Starting member in the list of attached resources (>=1)

number -- specified by user, fullword integer

Number of shell resource identifiers 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:

202: SPECIFIED NUCLEUS DOES NOT EXIST
211: RESOURCE TYPE IS INVALID
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 attached resources of the specified resource type.

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

List of identifiers belonging to the specified resource type.

Error Codes

None

Related Subroutines

GPATR: Attach Resource
GPDTR: Detach Resource
GPQOPW: Inquire Set of Open Workstations

RCP code

201336334 (X'0C00260E')