graPHIGS Programming Interface: Subroutine Reference

The graPHIGS Programming Interface : Subroutine Reference

GPQWSA - Inquire Set of Workstations to Which Associated

GPQWSA (strid, start, number, errind, totnum, lwsid)

Note:

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

Purpose

Use GPQWSA to inquire the list of workstations with which the specified structure in the currently selected structure store is associated.

This subroutine returns the number of workstations and list of workstation identifiers with which the specified structure is associated and are attached to the shell. Note that the total number of workstations returned by this subroutine may be less than the actual number of workstations with which the structure is associated, because some of the workstations may not be 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.

Parameters

strid -- specified by user, fullword integer

Structure identifier.

start -- specified by user, fullword integer

Starting member of the list of workstations (>=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 workstations to which the structure is associated.

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

List of workstation identifiers to which the specified structure is associated.

Error Codes

None

Related Subroutines

None

RCP code

201337099 ( X'0C00290B')