• saoListRegion
  • saoGetRegion
  • tclSaoRegion

    ABSTRACT:
       This file contains all routines that deal with regions and the SAO image
    

    saoListRegion

    DESCRIPTION:
      List the contents of the shared memory that keeps a record of which regions
      are loaded into which copies of FSAOimage.  saoListRegion will list region
      information for the current process only, or all processes running
      FSAOimage.  Information may also be obtained for a specific region or for
      all regions that are loaded into FSAOimage.  NOTE: no information is
      available for a region unless it is loaded into a currently running copy
      of FSAOimage.
    
    SYNTAX:
      saoListRegion [-a] [regname]
    	[-a]    Optional switch. If present, information for all
    		FSAOimages loaded with the named region will be       
    		listed.  If no regionname is given, information for all      
    		loaded regions will be listed.  If not given, only           
    		loaded regions associated with the current process will
    		be listed.
    	regname	Optional argument. Name of loaded region for which
    		information is requested.  If not given, information
    		for all regions will be listed.
    
    OUTPUT:
    	The information listed consists of the following -
    
                   Region Name     SAO Number      Process ID      Current?
    
                   reg0            1               1836            X
    
                          The mark in the 'Current?' column means reg0 was
                          loaded into FSAOimage 1 by the current process.
    
    EXAMPLES:
    	saoListRegion		List information about all regions loaded
    				into FSAOimage and belonging to the current
    				process.
    	saoListRegion reg0	List information about a any reg0 that was
    				loaded into FSAOimage by the current process.
    	saoListRegion reg0 -a	List information about any reg0 that was
    				loaded into FSAOimage by any process.
    	saoListRegion -a	List information about all regions loaded
    				into FSAOimage by any process.
    

    saoGetRegion

    DESCRIPTION:
       This extension returns a (possibly empty) Tcl list of FSAO numbers 
       currently in use. 
    
    SYNTAX:
       saoGetRegion
    
    RETURNS:
       TCL_OK : always, except if it cannot allocate memory, in which case there
                is no successful return. Tcl Interpreter will contain either an
                empty list, or a list of all FSAO numbers currently in use.