API Guide
601355 Rev A API Functions 2-741
Functions
Return Values VSCMD_MediaQuery_SetDefaults returns:
•VSE_TRUE - Successful execution.
•VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
•VSE_ERR_BADFIELD - An invalid parameter was
specified.
•VSE_ERR_BADSIZE - Value passed for a string parameter
exceeds the maximum allowable length for that parameter.
•VSE_ERR_NULLSTRING - A null value was passed to a
string argument.
Example 1 /****************************************
*********
2*
3 * FUNCTION: vst_mediaquery_defaults
4*
5 * PURPOSE:
6 * This function sets the default
parameters for the
7 * VSCMD_MediaQuery API call.
8*
9 * PARAMETERS:
10 * none
11 *
VSID_USER_FIELD (VST_USER_FIELD) Value to be put in USER_FIELD for Media
Query 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 Media Query
commands. Neither the API software nor
VolServ uses USER_FIELD.
Parameter Type Description