Name

PEXDeleteToLabel - Delete Elements to Label

Synopsis

void PEXDeleteToLabel(Display ∗display, PEXStructure structure, int whence, long offset, long label)

Arguments

displayA pointer to a display structure returned by a successful XOpenDisplay call. 

structureThe resource identifier of the structure. 

whenceA value specifying, with offset, the beginning of the range of elements to be deleted (PEXBeginning, PEXCurrent, PEXEnd).

offsetThe offset from whence denoting the beginning of the range of elements to be deleted. 

labelThe label specifying the end of the range of elements to be deleted. 

Returns

None

Description

This function deletes a range of elements between a computed offset and a specified label in the specified structure.  The computed offset specifies the beginning of the deletion range.  The label specifies the end of the deletion range.  Elements are deleted from the structure element immediately after the computed offset up to the next occurrence of the label.  The label is not deleted.  If label is not found, no elements are deleted. 

If the computed offset is less than zero, it is set to zero before the deletion occurs.  If the computed offset is greater than the number of elements in the structure, the offset is set to the offset of the last structure element.  Deleting the zero element is effectively a no-op.  After the deletion operation, the structure element pointer is set to the element immediately preceding the range of deleted elements. 

Data Structures

typedef XID             PEXStructure;

Errors

BadPEXLabel
The specified label does not exist.

BadPEXStructure
The specified structure resource identifier is invalid.

BadValueThe specified value for whence parameter is invalid. 

See Also

PEXCreateStructure, PEXLabel