CI Info Functions: Devinfo, Spoolinfo, Volinfo (14392)

intrinsic. Depending on the information desired, VOLINFO returns a
string, Boolean, or an integer.
Syntax
VOLINFO (VolumeID, item[,status])
Parameters
VOLINFO accepts three parameters:
• A volume ID: the volume, volume class or volume set about
which information is returned.
• An item indicating what information is desired.
• An optional status parameter to return the status of the function
call.
Volume ID
The volume ID parameter identifies a volume, volume class, or volume
set. Volumes can be specified by their name or their LDEV number. For
convenience, an LDEV number can be an integer or a string. A volume
within a volume set is specified as "
VolumeSet:VolumeName" or via its
corresponding LDEV number. A volume class within a volume set is
specified as "VolumeSet:VolumeClassName". Since "volset:volname"
and "volset:volclass" are syntactically ambiguous, all volume class items
have "volclass" in their name. For example, the value of parameter one
could be "abc:def" (which could name a volume or volume class), but if
the item selected is "VolClassExists" then it is obvious that parameter
one contains a volume class name. In all cases, it should be clear from
the item description what is expected in parameter one.
There are cases where parameter one is not a volume set, volume class,
LDEV, or volume name. For instance, to retrieve the number of volume
sets ("NumVS" item) the volume ID parameter can be wildcarded or set
to the empty string, "", meaning all or "@".
Item
This parameter is a key-word that indicates what information is required.
It is a string parameter. A list of supported items and their description
can be found in a separate section below. The list includes the item
name, its aliases, return type of VOLINFO and a description of the item.
Status
Status is an optional 32 bit integer parameter. It is the CI variable name
where a VOLINFO error number can be returned. Zero indicates
success. Non-zero indicates a failure. Error values returned in 'status'
are the same as the CIERROR value when an error occurs. If the
'status' parm is passed, the CI will not set CIERROR and will not report
an error message. If 'status' is not specified the CI performs its normal
error handling.
Description of VOLINFO Items
The following table summarizes the items of the VOLINFO CI function.
The description includes the item string, one or more aliases, the return
type, and a brief description of the item.
Item String
Type
Description
Drivetype String Returns the drive type of the specified volset:volname or
LDEV. The drive type is the product ID of the hard-disk.
E.g. ST15150W
Page
10
of
15
Communicator Article
-
Network Printing enhancement
7/30/2008
http://jazz.external.hp.com/papers/Communicator/7.5/CIInfoFunctions.html