Extended IDL Help

obj_clean.pro

At present this program is installed in the /usr/local/epics/extensions/idllib directory for EPICS R3.14. This program provides the utility routine OBJ_CLEAN to easily clean up various objects from the IDL heap.

List of Routines

Routine Descriptions

OBJ_CLEAN

 [List of Routines] 
 NAME:
	OBJ_CLEAN
 
 PURPOSE:
        This routine allows the user flexibly clean up the objects heap 
        in the IDL memory.

 CALLING SEQUENCE:
       OBJ_CLEAN[,Var[,cType]][,/FIND][,Class=class][,ID=id][,/ALL]

 INPUTS:
  Var   - if specified, the object name found will be destroyed
  cType - string specifies the Var class name, if specified,
          the Var class is also checked before destroy

KEYWORD PARAMETERS:
  /FIND  - if specified, find all the objects in the heap
  CLASS  - to specify the classType string, if specified with /FIND, 
           find all the objects matched the classType;
           if specified alone, all the matched objects will be destroyed.
  /ALL   - if specified, all the objects in the heap will be destroyed
  ID=#   - if specified, the #'th objects in the heap will be destroyed

 EXAMPLES:

     Find all the objects defined in the heap:       OBJ_CLEAN,/FIND

     Destroy all the objects defined in the heap:    OBJ_CLEAN,/ALL 

     Destroy all the objects with the 'scan2d' type: OBJ_CLEAN, class='scan2d'

     Destroy the third object from the heap:         OBJ_CLEAN,ID=3

     Destroy the object variable V2 from the heap:   OBJ_CLEAN,V2
        
        
 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-12-99.

(See obj_clean.pro)