API Guide
601355 Rev A API Functions 2-473
Functions
Return Values VSCMD_ArchiveQuery_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_archivequery_defaults
4*
5 * PURPOSE:
6 * This function sets the default
parameters for the
7 * VSCMD_ArchiveQuery API call.
8*
9 * PARAMETERS:
10 * none
11 *
12 ****************************************
*********/
13 #ifdef ANSI_C
14 VST_BOOLEAN
vst_archivequery_defaults(void)
15 #else
16 VST_BOOLEAN
vst_archivequery_defaults()
17 #endif
18 {
19 VST_BOOLEAN rc =
VSE_FALSE;