PEXSetEditingMode - Set Structure Editing Mode (5.0)


Synopsis

 
   void PEXSetEditingMode(
        Display *display,
        PEXStructure structure,
        int mode
   )
 

Arguments

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

structure
The resource identifier of the structure.

mode
The editing mode (PEXStructureInsert or PEXStructureReplace).

Returns

None.

Description

Invoke PEXSetEditingMode to set the editing mode for the specified structure.

The editing mode specifies how editing operations affect the structure. PEXlib defines the following editing modes (mode):

PEXStructureInsert -
subsequent requests to create structure elements cause elements to be inserted into the structure. This is the mode when a structure is created.

PEXStructureReplace -
output requests that create structure elements cause structure elements to replace elements, starting at the location specified by the element pointer. See the discussion in Replacing Structure Elements for some important considerations when replacing a series of elements.

The element pointer is then incremented by the number of elements inserted or replaced.

Errors

BadPEXStructure
The specified structure resource identifier is invalid.

BadPEXStructurePermission
The structure's permission is PEXStructureLocked.

BadValue
The specified value for mode is invalid.

See Also

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