2 isaspacket interface, 1 ipacket::getpacketdata – Teledyne LeCroy SAS_SATA Tracer_Trainer Automation API Manual User Manual

Page 62

Advertising
background image

LeCroy Corporation

Automation API for SAS/SATATracer/Trainer

Manual Version 1.11

62

6.2 ISASPacket Interface

The ISASPacket interface is a primary dual interface for the SASPacket object.

This interface is derived from the IPacket interface.

The ISASPacket interface implements all methods from the IPacket interface plus the
following:

GetPacketData
GetLinkNumber
GetFrameType
GetDirection
GetErrors
GetTotalDwords

6.2.1 IPacket::GetPacketData


HRESULT GetPacketData (
[in] EPacketFormat format,
[out] VARIANT* packet,
[out, retval] long* number_of_bytes )


Retrieves a raw packet representation.

Parameters

format

Data

representation

format

The EPacketFormat enumerator has the following values:
PACKETFORMAT_BYTES

( 0 )

bytes

PACKETFORMAT_SCRAMBLED_BYTES

( 1 )

scrambled bytes

PACKETFORMAT_TEN_BIT

( 2 )

10-bit codes

packet

Raw

packet

data

number_of_bytes

Number of bytes in the packet


Return values

ANALYZERCOMERROR_WRONGCALL

- Unknown packet format specified


Remarks

The packet parameter has VT_ARRAY | VT_VARIANT actual automation type.

For PACKETFORMAT_BYTES and PACKETFORMAT_SCRAMBLED_BYTES, each
element of this array has the VT_UI1 automation type.

For PACKETFORMAT_TEN_BIT, each element of this array has the VT_UI2 automation
type.


Advertising