1 07/25/86  term_
  2 
  3 The term_ subroutine performs the same operation as certain hcs_ entry
  4 points; however, the term_ entry points also unsnap links and deal with
  5 object MSFs correctly.  The term_ entry points and corresponding hcs_
  6 entry points are:
  7 
  8     term_                  hcs_$terminate_file
  9     term_$seg_ptr          hcs_$terminate_seg
 10     term_$single_refname   hcs_$terminate_name
 11 
 12 Use of the term_ subroutine is preferred to the corresponding hcs_
 13 entry points since term_ unsnaps links in addition to terminating the
 14 segment.  The term_ subroutine also deals with terminating portions
 15 of object MSFs by terminating all of the components to prevent them
 16 from becoming inconsistent.
 17 
 18 
 19 Entry points in term_:
 20    (List is generated by the help command)
 21 
 22 
 23 :Entry: term_: 07/25/86  term_
 24 
 25 
 26 Function: terminates the reference names of a segment or MSF and
 27 removes the file from the caller's address space and the appropriate
 28 combined linkage segment.  It also unsnaps any links in the combined
 29 linkage segments that contain references to the file.
 30 
 31 
 32 Syntax:
 33 declare term_ entry (char(*), char(*), fixed bin(35));
 34 call term_ (dir_path, entryname, code);
 35 
 36 
 37 Arguments:
 38 dir_path
 39    is the pathname of the containing directory.  (Input)
 40 entryname
 41    is the entryname of the segment or MSF.  (Input)
 42 code
 43    is a standard status code.  (Output)
 44 
 45 
 46 :Entry:  refname:  07/25/86 term_$refname
 47 
 48 
 49 Function:  This entry point performs the same function as the term_
 50 entry point given a reference name rather than a pathname.
 51 
 52 
 53 Syntax:
 54 declare term_$refname entry (char(*), fixed bin(35));
 55 call term_$refname (ref_name, code);
 56 
 57 
 58 Arguments:
 59 ref_name
 60    is the reference name of the segment or MSF.  (Input)
 61 code
 62    is a standard status code.  (Output)
 63 
 64 
 65 :Entry:  seg_ptr:  07/25/86 term_$seg_ptr
 66 
 67 
 68 Function:  This entry point performs the same function as the term_
 69 entry point given a pointer to the segment.  If the segment pointed
 70 to is a component of an object MSF, all of the components are
 71 terminated.
 72 
 73 
 74 Syntax:
 75 declare term_$seg_ptr entry (ptr, fixed bin(35));
 76 call term_$seg_ptr (seg_ptr, code);
 77 
 78 
 79 Arguments:
 80 seg_ptr
 81    is a pointer to the segment.  (Input)
 82 code
 83    is a standard status code.  (Output)
 84 
 85 
 86 :Entry:  single_refname:  07/25/86 term_$single_refname
 87 
 88 
 89 Function:  This entry point allows termination of a single reference
 90 name.  The segment or MSF is not made unknown unless the specified
 91 reference name was the only reference name initiated for the file.
 92 
 93 
 94 Syntax:
 95 declare term_$single_refname entry (char(*), fixed bin(35));
 96 call term_$single_refname (ref_name, code);
 97 
 98 
 99 Arguments:
100 ref_name
101    is a reference name of the file.  (Input)
102 code
103    is a standard status code.  (Output)
104 
105 
106 :Entry:  unsnap:  07/25/86 term_$unsnap
107 
108 
109 Function:  This entry point unsnaps links to the segment or MSF but
110 does not terminate any reference names or make the file unknown.
111 
112 
113 Syntax:
114 declare term_$unsnap entry (ptr, fixed bin(35));
115 call term_$unsnap (seg_ptr, code);
116 
117 
118 Arguments:
119 seg_ptr
120    is a pointer to the file.  (Input)
121 code
122    is a standard status code.  (Output)