Name

---

  MGH_OBJ_CLONE

Purpose

---

  Given a reference to an object heap variable, this function
  generates a copy and returns a reference to it.

Calling Sequence

---

  result = MGH_OBJ_CLONE(object)

Positional Parameters

---

  object (input, scalar object reference):
    Object to be copied.
  KEYWOED PARAMETERS:
  VERBOSE (input, switch):
    Control informational output.

Restrictions

---

  There are situations where cloning objects is unsuccessful because
  it leads to duplicate objects, dangling references, or
  inconsistencies between (say) a child's information about its
  parent and the parent's information about its children.
###########################################################################
  This software is provided subject to the following conditions:
  1. NIWA makes no representations or warranties regarding the
    accuracy of the software, the use to which the software may
    be put or the results to be obtained from the use of the
    software. Accordingly NIWA accepts no liability for any loss
    or damage (whether direct of indirect) incurred by any person
    through the use of or reliance on the software.
  2. NIWA is to be acknowledged as the original author of the
    software where the software is used or presented in any form.
###########################################################################

Modification History

---

  Mark Hadfield, Feb 1998:
    Written as OBJ_CLONE.
  Mark Hadfield, Sep 1998:
    Renamed MGH_OBJ_CLONE.
  Mark Hadfield, Aug 2000:
    Updated for IDL 5.4.