beautypg.com

Getfieldoptiondescription – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 415

background image


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

IExerciserEngine 415

GetFieldOptionDescription

BOOL GetFieldOptionDescription (

short iLayerID,

int nPacketIndexInLayer,

int nFieldIndex,

BSTR* pFieldOptionDescription);


Inputs
short iLayerID

Layer ID of a packet (see

SASLayerEnum

)

int nPacketIndexInLayer

Index of a packet corresponding to layer ID.

int nFieldIndex

Index of a field in packet.

BSTR* pFieldOptionDescription

Description of an option based on field value.


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

Remark
Returns a field option description in a packet based on field value.

See Also

GetPacketProperties

See also other documents in the category Teledyne LeCroy Equipment: