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

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
ISerialSCSICaptureProject 208
AddCapturePattern
long AddCapturePattern (
int nStateId,
PatternTypeEnum ePatternType,
VARIANT *vtDirection,
VARIANT *vtSubChannelDirection,
long* pErrorCode);
Inputs
int nStateId
ID for a state in advanced mode and Capture ID
(see Capture ID definition ) in easy mode.
PatternTypeEnum ePatternType
Pattern Type ID
(see Pattern Types definition ).
VARIANT *vtDirection
Direction of pattern.
This variant comes from a ByteArray type.
This Byte Array contains direction of all boards as byte.
VARIANT *vtSubChannelDirection Sub Channel Directions of pattern.
This variant comes from a ByteArray type.
This Byte Array contains Sub Channel direction of all
boards as byte.
This parameter is for the muxing feature. If the muxing
feature is disabled, insert zero to the byte array for Sub
Channel directions. Size of this array is equal to size of
Direction array.
long* plErrorCode Saves the Error Code if error occurs.
Return Value
Returns the index of the added pattern to use next.
Remark
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.