Teledyne LeCroy SierraFC Automation API - Manual (Page 68)

LeCroy Corporation SierraFC M8-4 API Reference Manual Manual Version 1.00
68
8.1.2 _IFCAnalyzerEvents::OnStatusReport
HRESULT OnStatusReport (
[in] short subsystem,
[in] short state,
[in] long percent_done );
Fires when there is a change in analyzer state or there is a change in progress
(percent_done) of analyzer state.
Parameters
subsystem Subsystem sending event has the following values
RECORDING_PROGRESS_REPORT ( 1 )
– recording subsystem
GENERATION_PROGRESS_REPORT ( 2 )
– generation subsystem
state Current analyzer state has the following values:
If the subsystem is RECORDING_PROGRESS_REPORT:
ANALYZERSTATE_IDLE (-1 ) -
idle
ANALYZERSTATE_WAITING_TRIGGER ( 0 ) – record in progress, anal. 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
If the subsystem is GENERATION_PROGRESS_REPORT:
ANALYZERSTATE_GEN_IDLE ( 400 ) -
idle
ANALYZERSTATE_GEN_DOWNLOADING ( 401 ) – generator is downloading object code
ANALYZERSTATE_GEN_GENERATING ( 402 ) – generator is working
ANALYZERSTATE_GEN_PAUSED ( 403 ) – generator is paused
percent_done Shows the progress of currently performing operation:
If the 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.
If the subsystem is GENERATION_PROGRESS_REPORT,
this parameter represents current position of script execution.
Return values
Remarks
Make sure the event handlers have __stdcall calling convention.