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

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual
API Description 3
Contents
Introduction ................................................................................................................ 29
API Description ................................................................................................ 29
COM Interfaces Supported ....................................................................... 31
Constants .................................................................................................. 32
Parameters ................................................................................................ 35
API Errors .................................................................................................. 35
How to Use the API .............................................................................................................. 36
Setup your API Application ............................................................................. 36
Initialize Your Application ............................................................................... 37
Set a valid path for the output file of your application ............................ 38
Declare two required objects in main class of your application .............. 38
Create Instances of the two objects just declared in the
main class of your application .................................................................. 39
Finalize initialization by calling “InitializeSystem ()”................................. 40
Connecting to the Board ................................................................................. 40
How to Set/Initialize Connection Points ......................................................... 44
Using Analyzer API .......................................................................................... 46
Initialize a Capture Project Object ............................................................ 47
Create a New Analyzer Capture Project ................................................... 47
Run an Analyzer Capture Project .............................................................. 49
Stop an Analyzer Capture Project ............................................................. 51
Upload and create sample file .................................................................. 52
Open a Saved Capture Project .................................................................. 55
Modifying an Existing Analyzer Project .................................................... 56
Set Trigger Mode/Strategy ...................................................................................................... 56
Add a Trigger Pattern............................................................................................................... 57
Remove a Trigger Pattern ........................................................................................................ 61
Set Capture Mode/ Strategy .................................................................................................... 62