Name

---

  MGH_OBJ_STRING

Purpose

---

  Given an object reference (or array thereof), this function returns
  a descriptive string, as generated by the PRINT command

Calling Sequence

---

  Result = MGH_OBJ_STRING(Obj)

Inputs

---

  Obj: An object reference.
  WARNING:
  If the SHOW_NAME or SHOW_TITLE keyword is set, then the function attempts to call
  the GetProperty method associated with the object in order to retrieve the name or title.
  If the method call raises an error, then the error is trapped silently and the name is
  left null. This is very slow (order 1 s per object) for objects that do not support
  a GetProperty method, as IDL will search the path if it can't find the method in memory.
###########################################################################
  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, Oct 1999:
    Written.
  Mark Hadfield, Feb 2000:
    Originally the object ID string was generated by printing to a file
    then reading the file. I just noticed the STRING function's PRINT keyword,
    which does this in one command.