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

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
Using Analyzer API 66
Remove a Capture Pattern
To remove an added capture pattern, call the RemoveCapturePattern () function of the
Capture Project object with the order of its parameters as below.
m_pICaptureProject->RemoveCapturePattern (nStateId,
lPatternIndex, bUpdateResource);
CSerialSCSICaptureProject::RemoveCapturePattern ()
Prototype
BOOL RemoveCapturePattern (int nStateId, long lPatternIndex,
BOOL bUpdateResource);
Usage BOOL = ->
RemoveCapturePattern (, ,
);
Inputs int nStateId: ID for a state in advanced mode and Capture ID
long lPatternIndex: Pattern Type Index
BOOL bUpdateResource: To set the status for Update Resource
Return Value Returns the success/ failure status of the pattern removal.
Description Removes a pattern from its capture items, by using its index and returns the
result.
NOTE: After adding any packet, if you do not call UpdateHardwareResource to assign a
resource, then to remove it bUpdateResource should be set to TRUE. Otherwise, FALSE.
Exclude/Include Specific Pattern Items
To exclude any specific pattern items, their respective method calls need to be made with their
corresponding parameters:
Pattern Item Function Name
Exclude SATA_CONT SetExcludeCONT ()
Exclude SATA_SYNC SetExcludeSYNC ()
Exclude OOB Signals SetExcludeOOBSignals ()
Exclude XXXX SetExcludeXXXX ()
Exclude ALIGN SetExcludeALIGN ()
Exclude RRDY SetExcludeRRDY ()
Exclude NOTIFY SetExcludeNOTIFY ()
Exclude Idle SetExcludeIdle ()
Exclude Payload Except SetExcludePayloadOffset ()