Isasanalyzer::setscenariotoport – Teledyne LeCroy SAS_SATA Automation API manual User Manual

Page 36

Advertising
background image

Teledyne LeCroy

SASAnalyzer Object

30

Automation API for Teledyne LeCroy SAS/SATA Protocol Suite

ISASAnalyzer::SetScenarioToPort

HRESULT SetScenarioToPort (

[in] int nBoardIndex
[in]int nPortIndex,
[in] BSTR bstrLibraryName,
[in] BSTR bstrScenarioName,
[out, retval] int* pnErrorCode);

This function assigns a scenario from mentioned library to a specific port of the board.

Parameters

nBoardIndex

Zero based index of board. If you have only one board, this 
parameter should be set to zero.

nPortIndex

Port index that the scenario should assign

bstrLibraryName

Specifies the name of the library 

bstrScenarioName Name of the scenario that will assigned to the specified port.

pnErrorCode

Pointer to an integer which contains an error code if one or 
more error(s) has occurred.

Return Values

ANALYZERCOMERROR_UNABLE_TO_START_JAMMER Software is in simulation 

mode

ANALYZERCOMERROR_UNABLESTARTRECORDING 

Failed to get LeCroy Scenario Manager

Failed to open LeCroy script local file database

Failed to get LeCroy Configure Manager

Failed to create LeCroy script local file database

Failed to load local file scenario

Failed to load local file scenario because invalid scenario

There is no scenario in local file.

Failed to upload the scenario to InFusion device

Failed to upload the scenario to InFusion device

Failed to upload the scenario to InFusion device

Failed to set selected the scenario from InFusion device

Can not find scenario in local file database

Remarks

Before a scenario is started, you must assign it to the available ports using this function. 

Advertising