GPCRET - Conditional Return

Purpose

Use GPCRET to insert a Conditional Return structure element into the open structure following the element pointer or to replace the element pointed at by the element pointer with a Conditional Return structure element depending on the current edit mode.

If the current condition flags selected by the mask parameter satisfy the specified criteria, then the traversal of the current structure is terminated and the traversal of the parent structure is resumed. Otherwise, no action is taken, and the element count is incremented.

The condition flag is a 32-bit bit string. Each bit is defined as follows:

    0                        15  16                       29  30     31
    --------------------------------------------------------------------------
    |                           |                            | cull |  prune |
    | reserved for application  |          reserved          | flag |  flag  |
    --------------------------------------------------------------------------
  High bit                                                               Low bit

Note:

Not all GSEs are supported on all workstations. Use the Inquire List of Generalized Structure Elements (GPQGSE) inquiry subroutine to determine the GSEs supported by an open workstation. See also the workstation descriptors described in The graPHIGS Programming Interface: Technical Reference

Parameters