1 02/13/84  expand_pathname_
  2 
  3 
  4 Entry points in expand_pathname_:
  5    (List is generated by the help command)
  6 
  7 
  8 :Entry: expand_pathname_: 02/13/84  expand_pathname_
  9 
 10 Function: converts a relative or absolute pathname into a
 11 directory name and entryname.
 12 
 13 
 14 Syntax:
 15 declare expand_pathname_ entry (char(*), char(*), char(*),
 16      fixed bin (35));
 17 call expand_pathname_ (pathname, dirname, entryname, code);
 18 
 19 
 20 Arguments:
 21 pathname
 22    is the relative or absolute pathname to be expanded.  (Input)
 23 dirname
 24    is the directory portion of the expanded pathname.  (Output)
 25 entryname
 26    is the entryname portion of the expanded pathname.  (Output)
 27 code
 28    is a standard system error code.  (Output) It can have one of the
 29    following values:
 30    error_table_$lesserr
 31       too many less-than characters ("<") in pathname.
 32    error_table_$badpath
 33       invalid syntax in pathname.
 34 
 35 
 36    error_table_$pathlong
 37       the expanded pathname is longer than 168 characters.
 38    error_table_$entlong
 39       the entryname of the expanded pathname is longer than 32
 40       characters.
 41    error_table_$no_wdir
 42       a relative pathname is specified, but no working directory is in
 43       force for the process.
 44    error_table_$archive_pathname
 45       the input pathname specified an archive component.
 46 
 47 
 48 Notes:  This entry does not accept the syntax for specifying archive
 49 component pathnames; if one is supplied, an error code is returned.
 50 See the information on Constructing and interpreting names in the
 51 Programmer's Reference Manual for details.
 52 
 53 For compatability with older programs, if pathname is given as a null
 54 string, the working directory is used.
 55 
 56 
 57 :Entry:  add_suffix:  02/13/84 expand_pathname_$add_suffix
 58 
 59 
 60 Function:  This entrypoint expands a relative or absolute pathname into
 61 a directory name and entryname portion, adding a suffix to the
 62 entryname if that suffix is not already present.
 63 
 64 
 65 Syntax:
 66 declare expand_pathname_$add_suffix entry (char(*), char(*), char(*),
 67      char(*), fixed bin (35));
 68 call expand_pathname_$add_suffix (pathname, suffix, dirname, entryname,
 69      code);
 70 
 71 
 72 Arguments:
 73 pathname
 74    is the relative or absolute pathname to be expanded.  (Input)
 75 suffix
 76    is the suffix to be added to the entryname.  (Input) The period
 77    separating the entryname and the suffix should not be included.  If
 78    a null string is supplied, no suffix is added.
 79 dirname
 80    is the directory portion of the expanded pathname.  (Output)
 81 entryname
 82    is the entryname portion of the expanded pathname.  (Output)
 83 code
 84    is a standard system error code.  (Output) It can have the same
 85    values described for expand_pathname_.
 86 
 87 
 88 :Entry:  component:  02/13/84 expand_pathname_$component
 89 
 90 
 91 Function:  This entrypoint expands a relative or absolute pathname into
 92 a directory name, an archive name, and an archive component portion, or
 93 into a directory name and entryname portion if no component name is
 94 present.
 95 
 96 
 97 Syntax:
 98 declare expand_pathname_$component entry (char(*), char(*), char(*),
 99      char(*), fixed bin (35));
100 call expand_pathname_$component (pathname, dirname, entryname,
101      componentname, code);
102 
103 
104 Arguments:
105 pathname
106    is the relative or absolute pathname to be expanded.  (Input)
107 dirname
108    is the directory name portion of the expanded pathname.  (Output)
109 entryname
110    if the input pathname specifies an archive component, this is the
111    entryname of the archive (with the archive suffix added).  (Output)
112    Otherwise, this is the entryname portion of the input pathname.
113 
114 
115 componentname
116    if the input pathname specifies an archive component, this is the
117    component name.  (Output) Otherwise, this is the null string.
118 code
119    is a standard system error code.  (Output) It can have the same
120    values as described for expand_pathname_ except for
121    error_table_$archive_pathname.
122 
123 
124 :Entry:  component_add_suffix:
125 02/13/84 expand_pathname_$component_add_suffix
126 
127 
128 Function:  This entrypoint expands a relative or absolute pathname into
129 a directory name, an entryname, and an archive component name.  The
130 specified suffix is added either to the entryname or component name, as
131 appropriate, if it is not already present.
132 
133 
134 Syntax:
135 declare expand_pathname_$component_add_suffix entry (char(*), char(*),
136      char(*), char(*), char(*), fixed bin(35));
137 call expand_pathname_$component_add_suffix (pathname, suffix, dirname,
138      entryname, componentname, code);
139 
140 
141 Arguments:
142 pathname
143    is the relative or absolute pathname to be expanded.  (Input)
144 suffix
145    is the suffix to be added to the component name or entryname.
146    (Input) The period separating the entryname and the suffix should
147    not be included.  If a null string is supplied, no suffix is added.
148 dirname
149    is the directory name portion of the expanded pathname.  (Output)
150 entryname
151    if the input pathname specifies an archive component, this is the
152    entryname of the archive (with the archive suffix added).  (Output)
153    Otherwise, this is the entryname portion of the input pathname, with
154    the specified suffix added if it is not already present.
155 
156 
157 componentname
158    if the input pathname specifies an archive component, this is the
159    component name, with the specified suffix added if it is not already
160    present.  (Output) Otherwise, this is the null string.
161 code
162    is a standard system error code.  (Output) It can have the same
163    values as for the expand_pathname_$component entry.