Teledyne LeCroy Automation API for Bluetooth Exercisers - Manual (Page 7)

CATC Automation API for CATC Bluetooth Exercisers Manual Version 1.01
4
VT_R4: Converted (truncated) to an integer CValue.
VT_R8: Converted (truncated) to an integer CValue.
VT_BOOL: Converted to an integer CValue.
VT_BSTR: Converted to a string CValue.
VT_ARRAY | VT_VARIANT | VT_BYREF: If it is a 1 dimensional array, it will be
converted into a list/array CValue. If it is not a one-dimensional array it will be
converted into a null CValue.
All other VARIANT types will convert into a null CValue.
Supported types of CValues when converting to a VARIANT are:
Null: Converted to a VT_NULL variant.
Integer: Converted to a VT_I4 variant.
String: Converted to a VT_BSTR variant.
Raw Bytes: Converted to a VT_ARRAY | VT_VARIANT variant. The elements of the
array are variants of type VT_I4 each containing one byte.
List: Converted to a VT_ARRAY | VT_VARIANT variant. Each element is a variant
that was created recursively from each CValue list element.
2.2 BTExerciser Class
The BTExerciser class is the base interface to the application. The BTExerciser interface
supports basic functionality such as retrieving log files, and manipulating data transfer
pipes, and examining the status of the application. From this interface, one can establish
connections to the various features of the application. Using explicit methods to retrieve
interfaces to other tools allows for a license check to be performed as well as checks to
prevent conflicting tools from being executed simultaneously.
2.2.1 OpenScriptManager Method
HRESULT OpenScriptManager( IDispatch** script_manager )
Opens the script manager feature and returns its interface. This will return failure if the
hardware is not properly connected, the script manager feature is not properly licensed, or
another client is currently accessing a tool. The interface returned by this method should
be released before accessing any other tool interfaces.
IDispatch** script_manager [out]:
Interface to the ScriptManager object described in Section 02.3 ScriptManager Class.
Errors:
BTEXERCISER_ERROR_BUSY:
The application is not in the ready mode.
BTEXERCISER_ERROR_NOT_LICENSED:
A license must be purchased from CATC in order to use this feature.
BTEXERCISER_ERROR_TOOL_OPEN:
Another tool (or another instance of the ScriptManager) is already open.