Name

PEXDeleteElements - Delete Elements

Synopsis

void PEXDeleteElements(Display ∗display, PEXStructure structure, int whence1, long offset1, int whence2, long offset2)

Arguments

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

structureThe resource identifier of the structure. 

whence1A value specifying, with offset1, the first limit of the range of elements to be deleted (PEXBeginning, PEXCurrent, PEXEnd).

offset1The offset from whence1 denoting the first limit of the range of elements to be deleted. 

whence2A value specifying, with offset2, the second limit of the range of elements to be deleted (PEXBeginning, PEXCurrent, PEXEnd).

offset2The offset from whence2 denoting the second limit of the range of elements to be deleted. 

Returns

None

Description

This function deletes a range of elements from the structure specified by structure. 

If a computed offset is less than zero, it is set to zero before obtaining the element information.  If a computed offset is greater than the number of elements in the structure, the offset is set to the offset of the last structure element in the structure.  Deleting the null 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

BadPEXStructure
The specified structure resource identifier is invalid.

BadValueThe specified value for whence parameter is invalid. 

See Also

PEXCreateStructure