Name

---

  MGH_VAR_STORE

Purpose

---

  Procedure MGH_VAR_SAVE creates a copy of an IDL variable at a call level
  different from the current one. It uses undocumented features of the
  built-in function ROUTINE_NAMES. See:
      http://astrog.physics.wisc.edu/~craigm/idl/introspect.html#ROUTINE_NAMES

Calling Sequence

---

  MGH_VAR_STORE, var

Arguments

---

  var (Input)
      The variable to be saved.

Keywords

---

  CLOBBER (Input)
      This keyword determines whether an existing variable is overwritten.
      Default is 1 (overwrite)--it is assumed that the caller knows what
      he/she is doing! Note that when CLOBBER is 0, checking the existence
      of a variable involves making a temporary copy of it, which may be
      expensive.
  LEVEL (Input)
      The level in the call stack at which the variable is to be stored.
      Default is 1 (main program).
  NAME (Input)
      The name under which the variable is to be known at the new level.
      Default is 'var0'
  VERBOSE (Input)
      This keyword determines whether an informational message is generated.
      Default is 1 (write message).

Side Effects

---

  Existing variables may be overwritten (see CLOBBER keyword).
###########################################################################
  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, 2001-11:
      Written.