1 02/06/84  release_temp_segment_
 2 
 3 
 4 Entry points in release_temp_segment_:
 5    (List is generated by the help command)
 6 
 7 
 8 :Entry: release_temp_segment_: 09/25/86  release_temp_segment_
 9 
10 Function: returns a temporary segment (acquired with the
11 get_temp_segment_ or the get_temp_segments_ subroutine) to the free
12 pool of temporary segments associated with the 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_segment_ entry (char(*), ptr, fixed bin(35));
20 call release_temp_segment_ (program, temp_seg_ptr, 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.  Besides giving the name of the command
28    or subroutine invoked by the user, it can also briefly describe how
29    the temporary segment is used; for example, "sort_seg (sort
30    indexes)."  (Input)
31 temp_seg_ptr
32    is a pointer to the temporary segment being released. (Input/Output)
33    It is set to null after the segment is successfully returned to the
34    free pool.  This fact can be used by callers to determine if a given
35    temporary segment has been released.  A null input value is not
36    treated as an error; no action is performed.
37 code
38    is a standard status code.  (Output)
39 
40 
41 Notes:  A nonzero status code is returned if the segment being released
42 was not assigned to the given program.  See the description of the
43 get_temp_segment_ or the get_temp_segments_ subroutine for a
44 description of how to acquire a temporary segment.