ADIC 601355 Rev A - page 261

API Guide
601355 Rev A API Functions 2-211
Functions
Notes The VSID_ERROR_OBJECT parameter tells specifically where
(in VolServ or an API object) the error occurred. If its value is
VSE_VOLSERV, the VSID_ERROR_NUMBER parameter matches
a VolServ error code in the VST_VOLERR_CODE error code. If
not, the VSID_ERROR_NUMBER parameter matches a value in
the VST_ERROR_NUMCODE type.
The VSID_ERROR_FILE and VSID_ERROR_LINE parameters
are valid only for API internal errors (e.g.,
VSE_ERR_OUTOFMEM).
The VSID_ERROR_CODE parameter is a human-readable code
that tells where the error occurred and gives the error number. It
is in the form AAAnnn, where AAA is an abbreviation that
corresponds with the VST_ERROR_OBJCODE type. If this
abbreviation is VOL, the error number is a VolServ error code.
Otherwise, it is in the VST_ERROR_NUMCODE type.
If the string parameters are not sufficiently long, unpredictable
results occur.
See Also • vsapi(l),
• VS_Command_GetFields(l),
• VS_Notify_GetFields(l)
Note
If the argument list does not end with VSID_ENDFIELD,
unpredictable results occur.