Ivscriptengineevents::onvscriptfinished – Teledyne LeCroy SAS_SATA Automation API manual User Manual

Page 137

Advertising
background image

 

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite

131

SASVScriptEngine Object Events

Teledyne LeCroy

IVScriptEngineEvents::OnVScriptFinished

HRESULT OnVScriptFinished (
[in] BSTR script_name,
[in] VS_RESULT result,
[in] int TAG )

Fires when running a verification script. Calls the ReportText(newLine) function (refer to 
the SASTracer Verification Script Engine Manual for details on the ReportText function).

Parameters

script_name

Name of the verification script

result

Result of  "verification"

See the 

ISASVerificationScript::RunVerificationScript

 method for details.

TAG

VSE object tag

Return Value

Remarks

Make sure that C++ event handlers have the __stdcall calling convention.

Example

C++:

HRESULT __stdcall CComplTestSink::OnVScriptFinished(
BSTR script_name,
VS_RESULT result, int TAG )
{
USES_CONVERSION;
TCHAR tmp[220];
sprintf( tmp, "Script completed, name : %s, result = %d,

TAG = %d",

W2A(script_name), result, TAG );
. . .

return S_OK;
}

VBA (MS Excel):
Public WithEvents VSEEvents As VScriptEngine
. . .

Private Sub VSEEvents_OnVScriptFinished( ByVal

script_name As String,

ByVal result As SASAutomationLib.VS_RESULT,
ByVal Tag As Long )

Advertising