rws_release_heap_pool()

RWS_$RELEASE_HEAP_POOL            Domain/OS             RWS_$RELEASE_HEAP_POOL


NAME
     rws_$release_heap_pool - release heap storage

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/rws.h>

     void rws_$release_heap_pool(
          void *&storage_ptr,
          rws_$pool_t &alloc_pool,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/rws.ins.pas';

     procedure rws_$release_heap_pool(
          in storage_ptr: univ_ptr;
          in alloc_pool: rws_$pool_t;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/rws.ins.ftn'

           integer*4 nwords
           parameter (nwords = 5000)

           integer*4 storage_ptr, status
           integer*2 alloc_pool, dummy(nwords)
           pointer /storage_ptr/ dummy

           call rws_$release_heap_pool(storage_ptr, alloc_pool, status)

DESCRIPTION
     Rws_$release_heap_pool releases the storage at storage_ptr back to the
     system.

     storage_ptr
          A pointer to storage allocated from the heap with
          rws_$alloc_heap_pool.

     alloc_pool
          The pool from which the storage was allocated.  Choose one of the
          following values:

          rws_$std_pool
               Storage allocated from the standard pool is private to the
               allocating process and is released during a UNIX exec(2) call.
               A pointer to storage allocated from the standard pool is not
               valid in another process.

          rws_$stream_tm_pool
               Storage allocated from the stream pool is private to the allo-
               cating process and is retained across a UNIX exec(2) call.  A
               pointer to storage allocated from the standard pool is not
               valid in another process.

          rws_$global_pool
               Storage allocated from the global pool is available to all
               processes running on a single node.  A pointer to storage allo-
               cated from the global pool may be used by all local processes
               to access a common storage area.

     status
          The completion status.

NOTES
     Unlike storage allocated with rws_$alloc_rw_pool, storage allocated with
     rws_$alloc_heap_pool can be released back to the system with
     rws_$release_heap_pool.
Museum
