PEXCopyStructure - Copy Structure (5.0)

Synopsis 

 
   void PEXCopyStructure(
        Display *display,
        PEXStructure src_structure,
        PEXStructure dst_structure
   )

Arguments

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

src_structure
The resource identifier of the source structure.

dst_structure
The resource identifier of the destination structure.

Returns

None.

Description

Invoke PEXCopyStructure to copy elements in the source structure (src_structure) to the destination structure (dst_structure).

Both structures must already exist as valid structure resources. This function deletes elements that are already in the destination structure. This function copies the element pointer and editing mode attributes of the source structure to the destination structure as well. This function does not modify the permission of the destination structure.

Errors

BadPEXStructure
A specified structure resource identifier is invalid.

BadPEXStructurePermission
Elements in a structure with a permission of PEXStructureWriteOnly cannot be copied to a structure which has a permission set to PEXStructureReadWrite. The structure also cannot be copied if the source structure or destination structure has the permission set to PEXStructureLocked.

See Also

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