beautypg.com

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

Page 442

background image


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

IExerciserEngine 442

GetPacketProperties

BOOL GetPacketProperties (
int nIndex,
short* pLayerID,
int* pFieldNumber,
BOOL* pExpandable,
BOOL* pIsExpanded,
BYTE* pLayerLevel,
int* pPacketIndexInLayer,
BYTE* pPacketDirection,
VARIANT* pStartTime,
long* pIdleTime,
long* pDurationTime,
BOOL* pHasBookmark,
short* piNumberOfPErrors,
VARIANT* pvtPErrorCodeList);

Inputs
int nIndex

Object index of a packet.

short* pLayerID

Layer ID of a packet (see

SASLayerEnum

)

int* pFieldNumber

Number of fields of a packet.

BOOL* pExpandable

Dummy parameter.

BOOL* pIsExpanded

Dummy parameter.

BYTE* pLayerLevel

Level of a packet.

int* pPacketIndexInLayer

Index of a packet corresponding to layer ID.

BYTE* pPacketDirection

Direction of a packet.

VARIANT* pStartTime

Start time of a packet.

long* pIdleTime

Dummy parameter.

long* pDurationTime

Dummy parameter.

BOOL* pHasBookmark

Dummy parameter.

short* piNumberOfPErrors

Number of protocol error assigned to a packet.

VARIANT* pvtPErrorCodeList CWordArray of protocol error assigned to a packet.

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