GPQE (start, number, errind, ndata, data) |
Purpose
Use GPQE to retrieve the current structure element content that is indicated by the element pointer. It will only return the data if the element is an element supported by Version 1 of the graPHIGS API
This subroutine returns the data contained in the current element. The number of bytes in the element and the element contents are returned. The element type can be determined by using the Inquire List of Element Headers (GPQEHD) subroutine (or, to maintain compatibility with previous releases, the Inquire Element Type and Size [ GPQETS] [page GPQETS - Inquire Element Type and Size] subroutine)
To execute this subroutine, a structure must be open.
For information on the format of the data, see The graPHIGS Programming Interface: Technical Reference
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:
This subroutine exists to maintain compatibility with previous graPHIGS API releases. The format of the data returned is different from that returned with the Inquire List of Element Data (GPQED) subroutine. This subroutine can not return the element content for all the new structure elements that were not supported in graPHIGS API Version 1. For the new structure elements, the Inquire List of Element Data (GPQED) subroutine must be used to get the element content.
Parameters
Error Codes
None
Related Subroutines
RCP code
201337090 (X'0C002902')