home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 10 / AU_CD10.iso / Updates / Perl / RPC / Docs / RISCOS-Library-Docs / DynamicArea.pm < prev    next >
Encoding:
Text File  |  1999-04-17  |  1.6 KB  |  50 lines
  1. NAME
  2.     RISCOS::DynamicArea -- routines to manipulate Dynamic Area
  3.  
  4. SYNOPSIS
  5.         use RISCOS::DynamicArea(dynamic_areas,name_dynamic_area);
  6.  
  7.         print join "\n", name_dynamic_area dynamic_areas';
  8.  
  9.  
  10. DESCRIPTION
  11.     `RISCOS::DynamicArea' provides routines to list and manipulate
  12.     dynamic areas.
  13.  
  14.   Methods
  15.  
  16.     dynamic_areas
  17.         `dynamic_areas' returns an list of the numbers of dynamic
  18.         areas.
  19.  
  20.     name_dynamic_area <number>, ...
  21.         `name_dynamic_area' converts dynamic area numbers to names.
  22.         In scalar context it returns the name of the dynamic area
  23.         given by the first argument. In array context it returns a
  24.         list of dynamic area names corresponding to the argument
  25.         list of dynamic area numbers.
  26.  
  27.     hash_dynamic_areas
  28.         `hash_dynamic_areas' returns a reference to a hash of
  29.         dynamic areas, keyed by name. If a name is unique to one
  30.         dynamic area then the hash value is that dynamic area's
  31.         number. If more than one dynamic area uses the same name,
  32.         then the hash value for that area is `undef'. Use `exists'
  33.         (see <perlfunc/exists>) to distinguish between names used
  34.         for 0 or for multiple areas.
  35.  
  36.     delete_dynamic_area
  37.         `delete_dynamic_area' deletes dynamic areas by number. In
  38.         scalar context it attempts to delete a single area,
  39.         returning 1 on success, 0 on failure. In array context it
  40.         returns a list of the results of attempting to the list of
  41.         area numbers passed to it.
  42.  
  43.  
  44. BUGS
  45.     None known.
  46.  
  47. AUTHOR
  48.     Nicholas Clark <nick@unfortu.net>
  49.  
  50.