HP 3000 Manuals HP 3000 Manuals
HPVOLINFO
Returns volume information.
Up to six items of information can be retrieved. They must be specified
in pairs (,itemnum, item) and separated by commas
Syntax
______________________________________________________
| |
| I32 I16 * |
| HPVOLINFO(status, volspecifiernum, volspecifier|
| I16 * |
| [,itemnum, item][...]); |
______________________________________________________
Parameters
status 32-bit integer (optional)
Returns the status of the HPVOLINFO call. If no errors
or warnings are encountered, status returns 32 bits of
zero. If errors or warnings are encountered, status is
interpreted as two 16-bit fields.
Bits (0:16) comprise status.info. A negative value
indicates an error. A positive value indicates a
warning.
Bits (16:16) comprise status.subsys. This value defines
the subsystem that set the status information. On MPE
XL, the volume management identification number is 163.
On MPE V, this field will contain a 0 (zero).
NOTE It is good programming practice to specify status and check its
value after the intrinsic call. If you do not specify status and
an error condition is encountered, HPVOLINFO causes the calling
process to abort.
The error (negative) / warning (positive) values of
status.info that can be returned from a call to
HPVOLINFO are given here.
Values marked with an asterisk (*) are returned only by
the MPE XL version of HPVOLINFO.
Value Meaning
--------------------------------------------------------------------------------------
0 No errors or warnings (successful call).
150 Array passed in cannot hold all names--list truncated.
151 File label is unreadable.
152 * Parts of the set or class are not mounted. Data was gathered on the
portion of the set or class that was mounted, so the data may be
incomplete.
-150 Invalid itemnum
-151 Missing itemnum or item (not paired).
-152 Required parameter omitted.
-153 Parameter address out of bounds.
-154 Split stack calls not allowed.
-155 Ldev, volume set/class, volume not mounted.
-156 Invalid volume specifier number.
-157 Invalid volume specifier.
-158 Ldev not a disk Ldev.
-159 Device class not configured for volumes.
-160 Device class does not map into a volume class.
-161 Free space range sizes not in ascending order.
-162 Invalid number of free space ranges specified.
-163 Volume class cannot be specified with system set.
-164 Error while scanning the directory.
-165 Volume label is unreadable.
-166 Disk free space map is bad.
-167 Allocation is disabled for disk free map.
-168 Defective tracks table is unreadable.
Value Meaning
--------------------------------------------------------------------------------------
-169 Disk I/O error.
-170 Virtual memory is only valid on system volumes.
-171 Directory size is not valid for specified volume.
-172 Spool files are valid only on system volumes.
-173 Item number is valid only on MPE XL systems.
-174 Item number is valid only on MPE V systems.
-175 List length specified is invalid.
-176 Item number / volume specifier number combination is illegal.
-177 Item is not yet implemented.
-178 Volume table is in an inconsistent state.
-179 Unrecognized drive type.
-180 * Physical I/O error.
-181 * An unexpected error was detected. Check the error stack to determine the
exact error.
-182 * An error was detected in the label management subsystem. Check the error
stack to determine the exact error.
-183 * Disk access error. Check the error stack to determine the exact error.
-184 * A mirrored volume that was specified is disabled.
-185 * The volume set specified is not a volume set on the system.
-186 * The volume class specified is not present in the volume set specified.
-187 * The member volume specified is not present in the volume set specified.
volspecifiernum 16-bit signed integer by value (optional)
A 16-bit integer indicating which volume specifier is to
be used to obtain information from HPVOLINFO. The
default value for volspecifiernum is 0 (zero) if it is
not included by the caller. This parameter is used in
conjunction with the volspecifier parameter.
The following are the valid volume specifier numbers:
Value Meaning
--------------------------------------------------------------------------------------
0 Volume specifier is ignored. Using 0 (zero) is the same as specifying
all the volumes on the system.
1 Volume specifier is the logical device number of the volume for which
information is to be obtained.
2 Volume specifier is a volume set name.
3 Volume specifier is a volume set/volume class name pair.
4 Volume specifier is a volume set/volume name pair.
5 Volume specifier is a device class name.
volspecifier Type varies (optional).
The volspecifier is optional when volspecifiernum is 0
(zero).
However, for a volspecifiernum of 1, 2, 3, 4, or 5, you
must specify a volspecifier parameter.
On MPE V, you must declare volspecifier as a byte array.
The data type of the volspecifier depends on the
volspecifiernum:
volspecifiernum volspecifier
---------------------------------------------------------------------------------------
0 Ignored
1 16-bit signed integer
2, 3, 4, 5 Character array
When 0 (zero) is used as the volspecifiernum, the
volspecifier is ignored. A volspecifiernum of 0 (zero)
refers to all the volumes on the system. This includes
all system and non-system volumes.
When 1 is used as the volspecifiernum, the volspecifier
must be an Ldev number that corresponds to a configured
and mounted volume. An Ldev number can be any number
from 1 through 999.
For character specifiers, the first character determines
the delimiter character for the parameter. The
delimiter must be printable; it cannot be alphanumeric
or one of the special characters ". , :" or "_" as
explained below. For example, to pass the volume set
MVSN1, you may use % as the delimiter:
%MVSN1%