1 02/06/84  release_temp_segments_
 2 
 3 
 4 Entry points in release_temp_segments_:
 5    (List is generated by the help command)
 6 
 7 
 8 :Entry: release_temp_segments_: 09/25/86  release_temp_segments_
 9 
10 Function: returns temporary segments (acquired with the
11 get_temp_segment_ or get_temp_segments_ subroutine) to the free pool
12 of temporary segments associated with each user process.  Through the
13 pool concept, temporary segments can be used more than once during the
14 life of a process.  Since the process does not have to create a new
15 segment each time one is needed, overhead costs are decreased.
16 
17 
18 Syntax:
19 declare release_temp_segments_ entry (char(*), (*) ptr, fixed bin(35));
20 call release_temp_segments_ (program, ptrs, code);
21 
22 
23 Arguments:
24 program
25    is a 32-character field identifying the program on whose behalf the
26    temporary segment is to be used.  This field is displayed by the
27    list_temp_segments command, and is also used by this subroutine to
28    identify the caller as the owner of the temporary segment being
29    released.  Besides giving the name of the command or subroutine
30    invoked by the user, it can also briefly describe how the temporary
31    segment is used; for example, "sort_seg (sort indexes)".  (Input)
32 ptrs
33    is an array of pointers to the temporary segments being released.
34    (Input/Output)  The pointers in the array are set to the null value
35    after the segments are successfully returned to the free pool.
36    This fact can be used by callers to determine if a given temporary
37    segment has been released.  Null input values are not treated as
38    errors; no action is performed for them.
39 code
40    is a standard system status code.  (Output)
41 
42 
43 Notes:  A nonzero status code is returned if any segment being released
44 was not assigned to the given program.  See the description of the
45 get_temp_segments_ or the get_temp_segment_ subroutine for a
46 description of how to acquire temporary segments.