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.
###########################################################################
  Copyright (c) 1998-2013 NIWA:
  http://www.niwa.co.nz/
  Licensed under the MIT open source license:
  http://www.opensource.org/licenses/mit-license.php
###########################################################################

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.