beautypg.com

Getifinstructioncondition, Getifinstructionconditiondes – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 420

background image


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

IExerciserEngine 420

GetIfInstructionCondition

BOOL GetIfInstructionCondition (

int nInstructionIndex,

ConditionEnum* peCondition);


Inputs
int nInstructionIndex

Index of an object (all instructions, including Send)

ConditionEnum* peCondition Condition value of If instruction (see

ConditionEnum

).


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

Remark
Returns condition value of If instruction. Call this method only for the If instruction.
Condition value can be changed based on previous command.

See Also

SetIfInstructionCondition

GetIfInstructionConditionDes

BOOL GetIfInstructionConditionDes (

int nInstructionIndex,

ConditionEnum eCondition,

BSTR* bstrConditionDesc);


Inputs
int nInstructionIndex

Index of an object (all instructions, including Send)

ConditionEnum eCondition

Condition type of If instruction(see

ConditionEnum

).

BSTR* bstrConditionDesc

Condition name of If instruction.


Return Value
Returns result of method, whether called by valid index and instruction type or not.
Remark
Returns Condition Description for a condition of If instruction. Call this method only for the If

instruction.