Teledyne LeCroy FireInspector Automation Application Programming Interface - Manual (Page 73)

69
FireInspector Automation User’s Manual CATC Version 1.0
2.7.3 _IAnalyzerEvents::OnStatusReport
Fired when there is a change in analyzer's state or there is a change in progress
(
percent_done ) of analyzer's state.
Syntax
HRESULT OnStatusReport (
[in] short subsystem,
[in] short state,
[in] long percent_done );
Parameters
• subsystem – subsystem sending event has the following values:
• RECORDING_PROGRESS_REPORT (1) – recording subsystem
• FwAnalyzer_SYNC (11) – synchronization subsystem
•
state – current analyzer state; has the following values:
if subsystem is RECORDING_PROGRESS_REPORT :
• ANALYZERSTATE_IDLE (-1 ) – idle
• ANALYZERSTATE_WAITING_TRIGGER ( 0 ) – recording in progress,
analyzer is waiting for trigger
• ANALYZERSTATE_RECORDING_TRIGGERED ( 1 ) – recording in progress,
analyzer triggered
• ANALYZERSTATE_UPLOADING_DATA ( 2 ) – uploading in progress
• ANALYZERSTATE_SAVING_DATA ( 3 ) – saving data in progress
•
percent_done – shows the progress of currently performing operation
(valid only if subsystem is RECORDING_PROGRESS_REPORT ):
• when analyzer state is ANALYZERSTATE_IDLE this parameter is not applicable
• when analyzer state is ANALYZERSTATE_WAITING_TRIGGER or
ANALYZERSTATE_RECORDING_TRIGGERED this parameter shows analyzer
memory utilization
• when analyzer state is ANALYZERSTATE_UPLOADING_DATA this parameter
shows the percent of data uploaded
• when analyzer state is ANALYZERSTATE_SAVING_DATA this parameter shows
the percent of data saved
Return values
Remarks
Make sure the event handlers have
_stdcall calling convention.
Example
VBScript:
<OBJECT
ID = Analyzer
CLASSID = "clsid:0B179BC1-DC61-11D4-9B71-000102566088" >
</OBJECT>
<P ALIGN=LEFT ID=StatusText></P>
<SCRIPT LANGUAGE="VBScript">
<!--
Function GetRecordingStatus(ByVal State, ByVal Percent)