PEXDeleteBetweenLabels - Delete Elements Between Labels (5.0)

Synopsis 

 
   void PEXDeleteBetweenLabels(
        Display *display,
        PEXStructure structure,
        long label1,
        long label2
   )

Arguments

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

structure
The resource identifier of the structure.

label1
The first label.

label2
The second label.

Returns

None.

Description

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

This function deletes the elements between the two labels. The label elements themselves are not deleted. A search for the first label (label1) starts at the current offset plus one. A search for the second label (label2) starts at the element following the first label. After the deletion operation, this function sets the structure element pointer to the pointer position at the first label (label1).

If this function does not find either of the two specified labels between the starting point of the search and the end of the structure, then no deletion occurs and the structure's element pointer is left unchanged.

Errors

BadPEXLabel
One or both labels were not found.

BadPEXStructure
The specified structure resource identifier is invalid.

BadPEXStructurePermission
The structure's permission is PEXStructureLocked.

See Also

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