ADIC 601355 Rev A - page 968

API Guide
2-918 API Functions 601355 Rev A
Return Values VSCMD_ModifyMediaClass returns:
•VSE_TRUE
- Successful execution if the API is operating in
synchronous mode.
- Good initial status received if the API is operating in
asynchronous mode.
•VSE_FALSE - The command failed.
A return code of VSE_FALSE (which is 0) means the
command failed.
To determine where the error occurred, and what the error
was, the client queries the command’s error handle (with
VS_Error_GetFields) to retrieve the error handle’s
object code.
VSID_USER_FIELD (VST_USER_FIELD) A value to put in USER_FIELD for Modify
Media Class commands. USER_FIELD is a
16-character field provided for user
information. Information entered in this field is
echoed back to the user in every status
message returned for Modify Media Class
commands. Neither the API software nor
VolServ uses USER_FIELD.
VSID_VERSION_NUMBER
(VST_VERSION_NUMBER) The RPC version number of the client process to receive callbacks generated for this
MediaClass group. VSID_VERSION_NUMBER
is required if VSID_CLASS_RPC_OPTION is
set to VSE_CLASS_RPC_ENTERPRISE.
Otherwise, VSID_VERSION_NUMBER is not
applicable.
Parameter Type Description