beautypg.com

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

Page 411

background image


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

IExerciserEngine 411

GetFieldDescription

BOOL GetFieldDescription (

short iLayerID,

int nPacketIndexInLayer,

int nFieldIndex,

BSTR* pFieldDescription);


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* pFieldDescription

Description of a field in packet.


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

Remark
Returns description of a field with field index of a packet corresponding to nPacketIndexInLayer

and iLayerID parameters.

See Also

GetPacketProperties


See also other documents in the category Teledyne LeCroy Equipment: