beautypg.com

Getfieldstream, Getfielddata – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 827

background image


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

ISerialSCSIExtraction 827

GetFieldStream

Void GetFieldStream (

short iLayerID,

int nPacketIndexInLayer,

int nFieldIndex,

RadixEnum eRadix,

DpDirect eDataDirection,

int nByteSeparated,

int nStartByte,

unsigned long* pulMaxByteCount,

BSTR* bstrFieldStream,

BOOL* bRetVal);


Inputs
short iLayerID

Layer ID. (see

SAS Layer Definition

)

int nPacketIndexInLayer ID

Packet index in a layer.

int nFieldIndex

Field index.

RadixEnum eRadix

Format of field data in stream. (see

Radix definition

)

DpDirect eData

DirectionDirection of data: LSB or MSB. (see

DpDirect

definition

)

int nByteSeparated

Number of bytes inserted in space.

int nStartByte

Byte from which field data was returned.

For example, if the field is 4 bytes, and start byte is 1,

Field stream contains byte 1 until 3.

unsigned long* pulMaxByteCount Number of bytes read.
BSTR* bstrFieldStream

Field data.


Return Value
Error code. If the function call was correct, the error code is zero.

Remark
Gets field data in a format for a packet.