Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual - Manual (Page 84)

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
Using Initiator/Host Emulator API Functions 84
Remove/Delete an Inserted Packet
To remove/delete an inserted packet from initiator, call the DeletePacket () function of
Exerciser Engine with Packet layer type and Packet Index in Layer as parameters, in the same
order as below.
int nRetVal = m_pExerciserEngine -> DeletePacket(iLayerType,
nPacketIndexInLayer);
CExerciserEngine::DeletePacket ()
Prototype
HRESULT DeletePacket (short iLayerType, int nPacketIndexInLayer, int* pRetVal);
Usage int nRetVal = -> DeletePacket
(, );
Inputs Short iLayerType: Layer ID of the packet (Refer to SASLayerEnum.)
Int nPacketIndexInLayer: Index of a packet corresponding to layer ID
Return Value Returns success/ failure status of the method with verification parameters as
Layer ID and Packet-Index-in-layer.
Description Call the DeletePacket () of Exerciser Engine to remove/delete any inserted
packet at the index specified as the second parameter of the function.
Remove/Delete an Inserted Event/Instruction
To remove/ delete an inserted Event/Instruction from initiator, call the DeleteInstruction ()
function of Exerciser Engine with Index of insertion as its only parameter.
int nRetVal = m_pExerciserEngine -> DeleteInstruction(nIndex);
CExerciserEngine::DeleteInstruction ()
Prototype
HRESULT DeleteInstruction (int nIndex, int* pRetVal);
Usage int nRetVal = ->
DeleteInstruction ();
Inputs Int nIndex: Index of a packet corresponding to layer ID
Return Value Returns success/failure status of the method in the form of an error code.
Description Call the DeleteInstruction () of Exerciser Engine to remove/ delete any inserted
event/ instruction at the index specified as the parameter of the function.