ADIC 601355 Rev A User Manual
API Guide
601355 Rev A
API Functions
2-669
Functions
VSCMD_
Export_
SetDefaults
Export_
SetDefaults
VSCMD_Export_SetDefaults
sets command-level
default parameters for the Export command.
Two levels of default parameter settings are used in the API
software—global defaults and command-specific defaults.
software—global defaults and command-specific defaults.
Synopsis
VST_BOOLEAN VSCMD_Export_SetDefaults
(
"…",
VSID_ENDFIELD )
(
"…",
VSID_ENDFIELD )
Arguments
•
"…"
= Variable length argument list consisting of pairs of
arguments. Each pair of arguments consists of a parameter
identifier, followed by the value to be used as a command
default value for the field. The valid parameter identifiers
and types for this function are shown in the following
"Parameters" paragraph.
identifier, followed by the value to be used as a command
default value for the field. The valid parameter identifiers
and types for this function are shown in the following
"Parameters" paragraph.
•
VSID_ENDFIELD
=
Re
quired at the end of the variable
length argument list to indicate the end of the list.
Parameters
Parameter Type
Description
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH)
(VST_CLIENT_DISPATCH)
Name of the client dispatch routine to receive
status for this request.
status for this request.
VSID_COMMENT (VST_COMMENT)
The export comment to use for these media.
The comment appears with media on the
archive’s eject list.
The comment appears with media on the
archive’s eject list.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID)
(VST_ENTERPRISE_ID)
Identifier of the enterprise, if any, to receive
final status for Export commands.
final status for Export commands.
VSID_MEDIA_ID_LIST (int)
Number of media in the list.