Filter
Top Products
API Guide
2-540 API Functions 601355 Rev A
Notes
The API must be initialized with a call to VS_Initialize
before this function can be executed.
VolServ does not generate intermediate status messages in
response to a Checkout request.
A Checkout request can trigger unsolicited status messages
from VolServ.
Checked-out media are unavailable for use by VolServ clients.
Failure of a Checkout request for one medium does not fail the
request for all specified media.
A medium can be checked out even if it is currently allocated.
Attempts to physically eject an allocated medium fail until the
medium is no longer is use.
The Checkout request only marks a specified medium for
logical check out and places the medium on the appropriate
archive’s Eject list. The medium is physically removed from the
archive when the operator ejects the medium from the archive.
A medium marked for check out can be unmarked (removed
from the Eject list) by the ClearEject request. An operator can
also remove a medium from the Eject list by performing an
Eject Fail operation from an archive console. The Eject Fail
functionality is available over the API interface via the
ClearEject request.
The total length of time the API software waits for a command
status in synchronous mode from VolServ is
(VSID_RETRY_LIMIT plus 1) multiplied by
VSID_TIMEOUT_VALUE.
If the VSID_ENTERPRISE_ID parameter is set to any value
other than zero, the intermediate and final status for this request
is returned to the enterprise registered with VolServ.