API Guide
2-534 API Functions 601355 Rev A
VSCMD_
Checkout VSCMD_Checkout checks media out of the VolServ system.
Media that are checked out are still known by VolServ, but are
unavailable for client allocation.
Upon receipt of a Checkout request, VolServ marks the
specified media for check out. If the specified media are
contained in archives, VolServ adds the media to the eject
candidate list of the containing archive. An operator must select
the Eject functionality from the appropriate archive’s console
display to physically remove the checked-out media from the
containing archive. The VolServ Eject functionality is not
available over the API interface.
The client may specify a comment on the VSCMD_Checkout
command. This comment is displayed on the applicable archive
console eject list for each medium being checked out.
Synopsis VST_BOOLEAN VSCMD_Checkout
(VST_COMMAND_HANDLE handle,
“…”,
VSID_ENDFIELD)
Arguments •handle = The command handle for this Checkout request.
•“…” = Variable length argument list consisting of pairs of
arguments. Each pair of Arguments consists of a parameter
identifier, followed by the value of the field to use for this
request. The valid parameter identifiers and types for this
function are shown in the following "Parameters"
paragraph.
•VSID_ENDFIELD = Required at the end of the variable
length argument list to indicate the end of the list.