beautypg.com

Getlablenote, Getlableproperties, Getlogicalunitnumber – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 429

background image


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

IExerciserEngine 429

GetLableNote

BOOL GetLableNote (

short iLabelId,

BSTR* bstrLabelNote);


Inputs
short iLabelId

Unique ID of a label.

BSTR* bstrLabelNote

Name of a label.


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

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

method would return FALSE.

GetLableProperties

BOOL GetLableProperties (

int nIndex,

short* piLabelId,

BSTR* pLabelNote);


Inputs
int nIndex

Index of a label.

short* piLabelId

Unique ID of a label.

BSTR* pLabelNote

Name of a label.


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

Remark
Gets properties of a label (label ID, Label Name) corresponding to a label index. If an index is an

invalid index, this method returns FALSE.