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

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
Using Analyzer API 64
CSerialSCSICaptureProject::AddCapturePattern ()
Prototype
long AddCapturePattern (int nStateID, PatternTypeEnum ePatternType,
VARIANT *vtDirection, VARIANT *vtSubChannelDirection,
long* pErrorCode);
Usage long <Pattern Index> = <Capture Project Object> ->
AddCapturePattern (<State Index>, <Pattern Type Enum>, <Direction of
Pattern>,
<Sub channel direction of pattern>, <Pointer to Error Code>);
Inputs int nStateId: ID for a state in advanced mode and Capture ID
PatternTypeEnum ePatternType: Pattern Type Index
VARIANT *vtDirection: Direction of Pattern
(This variant comes from a ByteArray type. This ByteArray Type contains
direction of all Boards as byte)
VARIANT *vtSubChannelDirection: Sub Channel Direction of the pattern
(This variant comes from a ByteArray type. This byte array contains sub channel
directions of all boards as bytes.
This parameter is for the Muxing feature. If the Muxing feature is disabled, then
insert zero to the byte array for the subchannel directions. Size of this array is
equal to the size of Direction array.)
Long *lErrorCode: Saves the error code if any error occurs.
Return Value Returns the index of Added pattern.
Description
Adds a pattern to Capture (Pre or Post) in easy mode or a state in advanced
mode, specified by its ID, and returns the new added pattern index and error
code if error occurs. If you want to change default strategy of capturing
(Everything), use this function to add a pattern to capturing items. You can
change the parameter value after adding a pattern by other functions, and then
call UpdateHardwareResource to assign related resources to the added pattern.