NAME

DgSetElePtrRelLabel − Set the group element pointer relative to a label

SYNOPSIS

C:

DtFlag DgSetElePtrRelLabel(label, offset)
DtInt label;
DtInt offset;

Fortran:

INTEGER∗4 DGSEPL(LABEL, OFFSET)
INTEGER∗4 LABEL
INTEGER∗4 OFFSET

DESCRIPTION

DgSetElePtrRelLabel sets the group element pointer to a position relative to the label, label, within the current open group.  Labels are elements that can be placed anywhere within a group to mark a special location.  There can be more than one label with the same value. 

DgSetElePtrRelLabel searches for the first occurrence of label starting from the current element pointer position. If no occurrence of the specified label exists between the element pointer and the end of the open group, DcFalse <DCFALS> is returned and the element pointer is left unchanged.  If the label is found, offset (either a positive or negative integer) is added to the label’s location to determine the new current group element pointer location.  Locations less than zero are set to zero; locations beyond the end of the group are set to the end of the group.  DcTrue <DCTRUE> is returned on completion. 

ERRORS

DgSetElePtrRelLabel will fail if no group is currently open. 

[WARNING - a group is not currently open]

SEE ALSO

DgInqElePtr(3D), DgSetElePtr(3D), DgSetElePtrRelLabel(3D), DoLabel(3D)

September 29, 2021