Assignlable, Changelable – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 396

Advertising
background image


Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

IExerciserEngine 396

AssignLable

int AssignLable (

int nInstructionIndex,

BSTR bstrLabelNote,

short* piLabelId);


Inputs
int nInstructionIndex

Index of an object (all instructions, including Send)


BSTR bstrLabelNote

Name of a label.


short* piLabelId

Unique ID of a label.


Return Value
Returns result of method, whether called by valid index or not.

Remark
Adds a label to an object and returns assigned label ID. This method can call packet (Send

instruction) and other instructions.

ChangeLable

int ChangeLable (

short iLabelId,

BSTR bstrLabelNote);


Inputs
short iLabelId

Unique ID of a label.


BSTR bstrLabelNote

Name of a label.


Return Value
Returns the Error Code if an error occurs.

Remark
Changes label name of a label corresponding to a label ID. If a Label ID was an invalid ID, this

method returns FALSE.

Advertising