PEXDeleteToLabel - Delete Elements to Label (5.0)

Synopsis 

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

Arguments

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

structure
The resource identifier of the structure.

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

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

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

Returns

None.

Description

Invoke PEXDeleteToLabel to delete 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, then no elements are deleted.

If the computed offset is less than zero, then it is set to zero before the deletion occurs. If the computed offset is greater than the number of elements in the structure, then the offset is set to the offset of the last element. After a successful deletion, the structure element pointer is set to the computed offset specified by whence and offset.

Errors

BadPEXLabel
The specified label does not exist.

BadPEXStructure
The specified structure resource identifier is invalid.

BadPEXStructurePermission
The structure's permission is PEXStructureLocked.

BadValue
The specified value for whence argument is invalid.

See Also

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