API Guide
1-20 Getting Started 601355 Rev A
Global Parameters

Global parameters are a group of parameters that are used by

the API for all VolServ requests. Most of these are sent to

VolServ, but some serve as control information for the API. The

following table describe these parameters.

Global Parameter Description
VSID_CLIENT_DISPATCH Pointer to the dispatch function for all commands.
VSID_ENTERPRISE_ID Identifier of the enterprise, if any, to receive intermediate and
final status on every command request.
VSID_NOTIFY_DISPATCH Pointer to the dispatch function used for notification
(MediaClass callback) processing.
VSID_PRIORITY
(defaults to 15)
Execution priority assigned to every command request.
Values range from 1 (highest) to 32 (lowest).
VSID_RETRY_LIMIT Number of times the API software is to retry for command
status from VolServ before returning a time-out to the client
software.
Total length of time the API software waits for a command
status from VolServ is (VSID_RETRY_LIMIT plus1) multiplied
by the VSID_TIMEOUT_VALUE.
VSID_RETRY_LIMIT is not applicable when the API software
executes in asynchronous mode.
VSID_STATUS_WAIT_FLAG Status wait flag for all commands. This flag controls whether
the API operates in synchronous or asynchronous mode. If its
value TRUE, the API waits for status (operate in synchronous
mode.) If its value is FALSE, the API operates in asyn chronous
mode.
VSID_TIMEOUT_VALUE Amount of time, in seconds, VolServ waits for status before
timing-out to the client software for this request.
VSID_USER_FIELD A 16-character field prov ided for user information. Information
entered in this field is echoed back to the user in every status
message returned for each command. Neither the API
software nor VolServ uses USER_FIELD.