1 09/04/81  resource_info_
  2 
  3 
  4 The resource_info_ subroutine returns selected information about RCP
  5 resource types defined on the system.
  6 
  7 
  8 Entry points in resource_info_:
  9    (List is generated by the help command)
 10 
 11 
 12 :Entry: get_type:  09/01/81  resource_info_$get_type
 13 
 14 
 15 Function:  This entry point, given the name of a resource type,
 16 indicates whether the resource type named is a device or a volume.
 17 
 18 
 19 Syntax:
 20 declare resource_info_$get_type entry (char (*), bit (1),
 21      fixed bin (35));
 22 call resource_info_$get_type (name, is_volume, code);
 23 
 24 
 25 Arguments:
 26 name
 27    is the name of a defined resource type (see "Notes" below).  (Input)
 28 is_volume
 29    is "1"b if the resource type given specifies a class of volumes.
 30    (Output) If "0"b, the resource type given specifies a class of
 31    devices.
 32 code
 33    is a standard status code.  (Output)
 34 
 35 
 36 Notes:  A list of defined resource types may be obtained via the
 37 list_resource_types command.
 38 
 39 
 40 :Entry: limits:  09/01/81  resource_info_$limits
 41 
 42 
 43 Function:  This entry point returns information about quantity and time
 44 limits for a given resource type.
 45 
 46 
 47 Syntax:
 48 declare resource_info_$limits entry (char (*), fixed bin, fixed bin,
 49      fixed bin, fixed bin (35));
 50 call resource_info_$limits (name, max_quantity, default_time, max_time,
 51      code);
 52 
 53 
 54 Arguments:
 55 name
 56    is the name of a defined resource type.  (Input)
 57 max_quantity
 58    is the maximum number of this type of resource that a process may
 59    assign at one time.  (Output)
 60 default_time
 61    is the default reservation time, in minutes, for this type of
 62    resource.  (Output)
 63 max_time
 64    is the maximum allowed reservation time, in minutes, for this type
 65    of resource.  (Output)
 66 code
 67    is a standard status code.  (Output)
 68 
 69 
 70 Notes:  The information returned by this entry point is from the RTDT.
 71 These are not the limits currently enforced by RCP.
 72 
 73 
 74 :Entry: mates:  09/01/81  resource_info_$mates
 75 
 76 
 77 Function:  This entry provides information about the resource type or
 78 types with which the given resource type may be mounted.
 79 
 80 
 81 Syntax:
 82 declare resource_info_$mates entry (char (*), fixed bin, char (*)
 83      dimension (*), fixed bin (35));
 84 call resource_info_$mates (name, n_mates, mates, code);
 85 
 86 
 87 Arguments:
 88 name
 89    is the name of a defined resource type.  (Input)
 90 n_mates
 91    is the number of mates returned.  (Output)
 92 mates
 93    contains the name or names of the resource type(s) that may be
 94    mounted with this resource (see "Notes" below).  (Output)
 95 code
 96    is a standard status code.  (Output)
 97 
 98 
 99 Notes:  If the number of elements in mates is too small to hold all the
100 mates for the given resource type, code is set to error_table_$smallarg
101 and mates is set to the null string.  However, n_mates still contains
102 the number of mates associated with the given resource type.
103 
104 
105 :Entry: defaults:  09/01/81  resource_info_$defaults
106 
107 
108 Function:  This entry point fills a resource_descriptions structure
109 with the default registration parameters defined in the RTDT.
110 
111 
112 Syntax:
113 dcl resource_info_$defaults entry (char(*), char(*), pointer,
114      fixed bin, fixed bin(35));
115 call resource_info_$defaults (name, subtype, resource_desc_ptr,
116      resource_no, code);
117 
118 Arguments:
119 name
120    is the name of a defined resource type.  (Input)
121 subtype
122    is the name of a subtype of the resource type, defined in the RTDT.
123    (Input) If subtype is the null string, the master defaults for the
124    resource type are used.
125 resource_desc_ptr
126    is the pointer to the entire resource_descriptions structure. (Input)
127 resource_no
128    specifies the resource description structure as defined by
129    resource_description_item (resource_no).  If resource_no is 0, all
130    items are used.  (Input)
131 code
132    is a standard status code.  (Output)
133 
134 
135 :Entry: lock_on_release:  09/01/81  resource_info_$lock_on_release
136 
137 
138 Function:  This entry point returns a value specifying whether
139 resources of a given type are to be locked for manual clearing at
140 release time.
141 
142 
143 Syntax:
144 dcl resource_info_$lock_on_release entry (char(*), bit(1) aligned,
145      fixed bin(35));
146 call resource_info_$lock_on_release (name, lock_sw, code);
147 
148 
149 Arguments:
150 name
151    is the name of a defined resource type.  (Input)
152 lock_sw
153    specifies whether the resource is locked at release time.  (Output)
154    "1"b   lock the resource
155    "0"b   do not lock the resource
156 code
157    is a standard status code.  (Output)
158 
159 
160 :Entry: canonicalize_name:  09/01/81  resource_info_$canonicalize_name
161 
162 
163 Function:  This entry point applies the proper canonicalization to a
164 resource name of a given resource type.  See "Canonicalization
165 Routines" in the MAM RCP.
166 
167 
168 Syntax:
169 declare resource_info_$canonicalize_name entry (char(*), char(*),
170      char(*), fixed bin(35));
171 call resource_info_$canonicalize_name (resource_type, resource_name,
172      canonicalized_name, code);
173 
174 
175 Arguments:
176 resource_type
177    is the name of a defined resource type.  (Input)
178 resource_name
179    is the string to be canonicalized.  (Input)
180 canonicalized_name
181    is the canonicalized representation of resource_name.  (Output)
182 code
183    is a standard status code.  (Output)