Ivscriptengine::vscriptname – Teledyne LeCroy SAS_SATA Automation API manual User Manual

Page 120

Advertising
background image

Teledyne LeCroy

SASVScriptEngine Object

114

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite

IVScriptEngine::VScriptName

[propget] HRESULT VScriptName ( [out, retval] BSTR

*pVal )

[propget] HRESULT VScriptName ( [in] BSTR newVal

)

Property puts and gets current verification script name.

Parameters

pVal

Address of the variable where current verification script name is kept

newVal

Name of the verification script to initialize verification script engine

Return Values

Remarks

The name of the verification script is the name of the verification script file (*.pevs). If 
only the script name, without a file extension, is specified, the Sierra/STX server searches 
for the named script among the scripts loaded from the \Scripts\VFScripts folder under 
the SAS/SATA Protocol Suite installation folder. If the full path to the script is specified, 
then the server attempts to load the script from the specified path prior to running it.

Example

C++:
// This example uses wrapper functions provided by the

#import directive.

ISASTrace* sas_trace;

. . .

ISASVerificationScript* sas_vscript = NULL;

sas_trace->QueryInterface(IID_ISASVerificationScript,
(void**)&sas_vscript))
assert( sas_vscript != NULL );

IVScriptEngine* sas_vsengine = NULL;
sas_vsengine = sas_vscript ->

GetVScriptEngine("MyVSEngine");

assert( sas_vsengine != NULL );

sas_vsengine -> PutVScriptName("Test_1");
assert( sas_vsengine -> GetVScriptName() == "Test_1" );

Advertising