PEXDeleteElements - Delete Elements (5.0)

Synopsis 

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

Arguments

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

structure
The resource identifier of the structure.

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

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

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

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

Returns

None.

Description

Invoke PEXDeleteElements to delete a range of elements from the structure specified by structure.

If a computed offset is less than zero, then this function sets the offset to zero before obtaining the element information. If a computed offset is greater than the number of elements in the structure, then this function sets the offset to the offset of the last element in the structure. If you delete a null element set, then the result is effectively a no-op. Position 0 may be in the range, but no element is deleted for that position.

After the deletion operation, this function sets the structure element pointer to the element immediately preceding the range of deleted elements.

Errors

BadPEXStructure
The specified structure resource identifier is invalid.

BadPEXStructurePermission
The structure's permission is PEXStructureLocked.

BadValue
The specified value for a whence argument is invalid.

See Also

For a list of all Structure functions and related topics, see Structures.