API Guide
2-520 API Functions 601355 Rev A
VSCMD_
Checkin
VSCMD_Checkin checks media into the VolServ system.
Only media that have been previously checked out can be
checked in.
Checkin is a logical operation. After a medium is logically
checked into the VolServ system, the medium must be
physically entered into an archive before becoming available
for client use (mounting,…).
A medium is physically entered into the VolServ system via the
Enter functionality available from the appropriate archive's
console display. The Enter functionality is not available through
the API interface.
If a destination archive is not specified on a VSCMD_Checkin
request, the media are returned to the archive where they were
checked-out.
Synopsis
VST_BOOLEAN VSCMD_Checkin
(VST_COMMAND_HANDLE
handle,
“…”,
VSID_ENDFIELD)
Arguments • handle = The command handle for this Checkin 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.
