API Guide
601355 Rev A API Functions 2-27
Functions
Return Values VS_Archive_SetFields returns:
VSE_TRUE - Successful execution.
VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
VSE_ERR_BADHANDLE - Specified handle was not a
criteria handle.
VSE_ERR_BADSIZE - The value passed for a string
parameter exceeds the maximum allowable length for that
parameter.
VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
VSE_ERR_NULLSTRING - A null value was passed to a
string argument.
Example 249/**************************************
***********
250*
251* FUNCTION: vst_archive_handle
252*
253* PURPOSE:
254* This function tests an archive handle.
255*
256* PARAMETERS:
257* none
258*
259***************************************
**********/
260#ifdef ANSI_C
261 VST_BOOLEAN vst_archive_handle(void)
262#else
263 VST_BOOLEAN vst_archive_handle(void)
264#endif
265{
266 VST_BOOLEAN rc =
VSE_FALSE;