[ Previous | Next | Contents | Glossary | Home | Search ]
The graPHIGS Programming Interface : Subroutine Reference

GPQETS - Inquire Element Type and Size

GPQETS (errind, type, size)

Purpose

Use GPQETS to inquire the type and size of the current element. It will only return the data if the current element is an element supported by Version 1 of the graPHIGS API

The subroutine returns the element type and size in bytes. To use this subroutine a structure must be open. If the element pointer is currently zero, a value of zero is returned in the type parameter. To retrieve the element contents, use the Inquire List of Element Data (GPQED) subroutine or, to maintain compatibility with previous releases, use Inquire Element Content (GPQE) subroutine.

Note:

This subroutine exists to maintain compatibility with previous graPHIGS API releases. The format of the data returned is different from that returned with GPQED This subroutine can not return the element header information (type and size) for all the new structure elements that were not supported in graPHIGS API Version 1. For the new structure elements, use the Inquire List of Element Headers (GPQEHD) subroutine which must be used to get the element header information.

Parameters

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:
4
FUNCTION REQUIRES STATE STOP
526
REQUESTED DATA NOT AVAILABLE FOR THIS FUNCTION

type -- returned by the graPHIGS API, fullword integer

Element type.

A value of zero indicates that the current element pointer is zero. Otherwise, current element types are as follows:

  • 4352 - Polyline 3

  • 4353 - Polyline 2

  • 4354 - Polymarker 3

  • 4355 - Polymarker 2

  • 4356 - Text 3

  • 4357 - Text 2

  • 4358 - Polygon 3

  • 4359 - Polygon 2

  • 4366 - Annotation 3

  • 4367 - Annotation 2

  • 4368 - Pixel 3 (GDP Identifier = 1001)

  • 4369 - Pixel 2 (GDP Identifier = 1002)

  • 4370 - Disjoint Polyline 3 (GDP Identifier = 1003)

  • 4371 - Disjoint Polyline 2 (GDP Identifier = 1004)

  • 4372 - Circle 2 (GDP Identifier = 1005)

  • 4373 - Circular Arc 2 (GDP Identifier = 1006)

  • 4374 - Ellipse 2 (GDP Identifier = 1007)

  • 4375 - Ellipse 3 (GDP Identifier = 1008)

  • 4376 - Elliptical Arc 2 (GDP Identifier = 1009)

  • 4377 - Elliptical Arc 3 (GDP Identifier = 1010)

  • 4608 - Set Polyline Index

  • 4609 - Set Polymarker Index

  • 4610 - Set Text Index

  • 4611 - Set Edge Index

  • 4612 - Set Interior Index

  • 4864 - Set Linetype

  • 4865 - Set Linewidth Scale Factor

  • 4866 - Set Polyline Color Index

  • 4867 - Set Marker Type

  • 4868 - Set Marker Size Scale Factor

  • 4869 - Set Polymarker Color Index

  • 4870 - Set Text Font

  • 4871 - Set Text Precision

  • 4872 - Set Character Expansion Factor

  • 4873 - Set Character Spacing

  • 4874 - Set Text Color Index

  • 4875 - Set Character Height

  • 4876 - Set Character Up Vector

  • 4877 - Set Text Path

  • 4880 - Set Text Alignment

  • 4881 - Set Interior Style

  • 4882 - Set Interior Style Index

  • 4883 - Set Interior Color Index

  • 4884 - Set Edge Flag

  • 4885 - Set Edge Linetype

  • 4886 - Set Edge Color Index

  • 4887 - Set Edge Scale Factor

  • 4894 - Set Aspect Source Flag Setting

  • 4895 - Set Annotation Height Scale Factor

  • 4897 - Set Polyline End Type

  • 5120 - Set Modeling Transformation 3

  • 5121 - Set Modeling Transformation 2

  • 5122 - Set Global Transformation 3

  • 5123 - Set Global Transformation 2

  • 5376 - Label

  • 5377 - Execute Structure

  • 5378 - Application Data

  • 5379 - Add Class Name to Set

  • 5380 - Remove Class Name from Set

  • 5381 - Set Pick Id

  • 5382 - Set Highlighting Color Index
  • size -- returned by the graPHIGS API, fullword integer

    Element size in bytes.

    Note:

    To retrieve the element's contents, the value of this parameter can be used as input to the Inquire Element Content (GPQE) subroutine. The value of this parameter is an estimate and may be larger than the actual element size.

    Error Codes

    None

    Related Subroutines

    GPQE
    Inquire Element Content
    GPQED
    Inquire List of Element Data
    GPQEHD
    Inquire List of Element Headers

    RCP code

    201337092 (X'0C002904')


    [ Previous | Next | Contents | Glossary | Home | Search ]