.\" @(#)PEXDeleteToLabel.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXDeleteToLabel 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXDeleteToLabel \- Delete Elements to Label
.SH SYNTAX
.HP
void PEXDeleteToLabel\^(\^Display *\fIdisplay\fP\^, PEXStructure \fIstructure\fP\^, int \fIwhence\fP\^, long \fIoffset\fP\^, long \fIlabel\fP\^)
.SH PARAMETERS
.TP 1i
\fIdisplay\fP
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.TP
\fIstructure\fP
The resource identifier of the structure.
.TP
\fIwhence\fP
A value specifying, with offset, the beginning of the range of elements to be
deleted (
.B PEXBeginning,
.B PEXCurrent,
.B PEXEnd
).
.TP
\fIoffset\fP
The offset from
.I whence
denoting the beginning of the range of elements to be deleted.
.TP
\fIlabel\fP
The label specifying the end of the range of elements to be deleted.
.SH RETURNS
None
.SH DESCRIPTION
.\" indexing
.IX PEXDeleteToLabel
.LP
This function deletes a range of elements between a computed
.I offset
and a
specified
.I label
in the specified
.I structure.
The computed
.I offset
specifies the beginning of the
deletion range.  The
.I label
specifies the end of the deletion
range.  Elements are deleted from the structure element immediately
after the computed
.I offset
up to the next occurrence of the
.I label.
The
.I label
is not deleted.  If
.I label
is not found, no
elements are deleted.
.LP
If the computed
.I offset
is less than zero, it is set to zero
before the deletion occurs.  If the computed
.I offset
is greater
than the number of elements in the
.I structure,
the
.I offset
is set to the
.I offset
of the last
.I structure
element.  Deleting the zero
element is effectively a no-op.  After the deletion operation,
the
.I structure
element pointer is set to the element immediately
preceding the range of deleted elements.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXStructure;
.fi
.sp
.SH ERRORS
.TP
.SB BadPEXLabel
The specified label does not exist.
.TP
.SB BadPEXStructure
The specified
.I structure
resource identifier is invalid.
.TP
.SB BadValue
The specified value for whence parameter is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateStructure (3)
.BR PEXLabel (3)
.fi