Teledyne-lecroy Conquest API Manual - API Manual Manual de usuario

For Software Version 7.40September 2008PROTOCOL SOLUTIONS GROUP3385 SCOTT BLVDSANTA CLARA, CA 95054ConquestApplication Program Interface (API)ManualV

IUsbGeneral Services Interface4AttachToDeviceDeclaration: long AttachToDevice(LPCTSTR lpctstrMacAddress)Input(s): lpctstrMacAddress specifies hardware

IusbEasyDataCapturePrj Interface5IusbEasyDataCapturePrj InterfaceThis interface allows you to create an Easy Data Capture project or open and modify a

IusbEasyDataCapturePrj Interface6GetCaptureAndTriggerDeclaration: ICaptureAndTrigger GetCaptureAndTrigger()Input(s): NoneReturn Value: Capture and Tri

IusbEasyDataCapturePrj Interface7SaveDeclaration: long Save(LPCTSTR strFilePath)Input(s): strFilePath points to the fully qualified path to save the f

IusbEasyDataCapturePrj Interface8GetAnalyzerTypeDeclaration: short GetAnalyzerType()Input(s): NoneReturn Value: Returns selected Analyzer type. Valid

IusbEasyDataCapturePrj Interface9SetPreTriggerDeclaration: long SetPreTrigger(short sPreTigger)Input(s): sPreTigger sets pre-trigger percent. It can b

IusbEasyDataCapturePrj Interface10GetSamplesNoDeclaration: long GetSamplesNo()Input(s): NoneOutput(s) NoneReturn Value Samples numberRemark: Returns t

CaptureAndTrigger11CaptureAndTriggerThis interface sets the Easy Capture Project parameters (for example, Trigger point and capture data). (This is eq

CaptureAndTrigger12SetTriggerTypeDeclaration: long SetTriggerType(short sTriggerType)Input(s): sTriggerType specifies type of USB object on which to t

CaptureAndTrigger13SetTriggerDeviceAddressDeclaration: long SetTiggerDeviceAddress(LPCTSTR strDeviceAddress)Input(s): strDeviceAddress specifies devic

Document DisclaimerThe information in this document has been carefully checked and is believed to be reliable. However, no responsibility can be assum

CaptureAndTrigger14SetTriggerDataPacketDeclaration: long SetTriggerDataPacket(short sDataPacketType, LPCTSTR strData, BOOL bIsDataBlock)Input(s): sDat

CaptureAndTrigger15SetDataCapture1Declaration: long SetDataCapture1(short sCaptureType, LPCTSTR strDeviceAddress, LPCTSTR strEndPoint)Input(s): sCaptu

CaptureAndTrigger16SetDataCapture2Declaration: long SetDataCapture2(short sCaptureType, LPCTSTR strDeviceAddress, LPCTSTR strEndPoint)Input(s): sCaptu

CaptureAndTrigger17SetDataCapture3Declaration: long SetDataCapture3(short sCaptureType, LPCTSTR strDeviceAddress, LPCTSTR strEndPoint)Input(s): sCaptu

CaptureAndTrigger18IsExcludeNakedTransactionsDeclaration: BOOL IsExcludeNAKedTransactions()Input(s): NoneReturn Value: Status of exclude NAK’ed transa

CaptureAndTrigger19ExcludeSOFPacketsDeclaration: void ExcludeSOFPackets(BOOL bExclude)Input(s): bExclude sets exclude SOF packets flag.Return Value: N

IExerciser20IExerciserThis interface creates an exerciser program for an easy data capture project(This isequivalent to the Exerciser page in an Easy

IExerciser21AddCommandDeclaration: long AddCommand(short sCommandType, short sDeviceIndex, const VARIANT& vtParam1, const VARIANT& vtParam2, c

IExerciser22AddUserDefineCommandDeclaration: long AddUserDefineCommand(short sSpeed, short sDeviceAddress, short sEndpointNo, short sEndpointType, sho

IExerciser23InsertCommandDeclaration: long InsertCommand(short sInsertAt, short sCommandType, short sDeviceIndex, const VARIANT& vtParam1, const V

ContentsiiiIntroduction - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1Using the Library - - - - - - - - - - - -

IExerciser24InsertUserDefineCommandDeclaration: long InsertUserDefineCommand(short sInsertAt, short sSpeed, short sDeviceAddress, short sEndpointNo, s

IExerciser25DeleteAllCommandsDeclaration: long DeleteAllCommands()Input(s): NoneReturn Value: Error code or zero (no error)Remark: Deletes all exercis

IExerciser26FindDeviceDeclaration: long FindDevice()Inputs: NoneReturn Value: Error code or zero (no error)Remark: This function finds any devices tha

IExerciser27GetEndPointDirectionDeclaration: long GetEndPointDirection(short sDeviceIndex, short sEndPointIndex, short* sDirection)Input(s): sDeviceIn

IExerciser28SetStartExerciserWithDeclaration: long SetStartExerciserWith(short sEventType)Input(s): sEventType specifies type of event with which the

ISetting29ISettingThis interface sets values of a project. (This is an equivalent to Setting page in Easy (or Advance) capture project in the software

ISetting30SetAnalyzerSpeedDeclaration: long SetAnalyzerSpeed(short sAnalyzerSpeed)Input(s): sAnalyzerSpeed sets the speed of the analyzer. Valid analy

ISetting31SetExternalTriggerTypeDeclaration: long SetExternalTriggerType(short sTriggerType)Input(s): sTriggerType sets external trigger type. Valid e

ISetting32GetNonStdClockRateTypeDeclaration: short GetNonStdClockRateType()Input(s): NoneReturn Value: Non-standard clock rate type. Valid types are d

ISetting33EnableHighSpeedTestModeDeclaration: void EnableHighSpeedTestMode(BOOL bEnable)Input(s): bEnable sets status of the high-speed test mode flag

ContentsivCaptureAndTrigger - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 11SetTriggerType - - - - - - - - - - - -

API Constants34API ConstantsPre-defined API constants are in the SBAEAPIConstants.h file The following constants are used as parameters by some functi

API Constants35Data Packet Type definitionsAPI_MAX_TRIG_DATA_PACKET_TYPES 5API_DATA_PACKET_TYPE_ANY 0API_DATA_PACKET_TYPE_DATA0 1API_DATA_PACKET_TYPE_

API Constants36Exerciser Command Type definitionsAPI_MAX_EXR_COMMAND_TYPES 18 API_EXR_COMMAND_GET_CONFIGURATION 0API_EXR_COMMAND_GET_DESCRIPTO 1API_EX

API Constants37Protocol Error Type definitionsAPI_MAX_PROTOCOL_ERROR_TYPES 13 API_PE_BIT_STUFF 0API_PE_PID_CHECK 1API_PE_PID_UNKNOWN 2API_PE_SYNCH 3AP

API Constants38Endpoint Type definitionsAPI_MAX_ENDPOINT_TYPES 4 API_ENDPOINT_TYPE_CONTROL 0API_ENDPOINT_TYPE_ISO 1 // IsochronousAPI_ENDPOINT_TYPE_BU

API ErrorsError codes are in the SBAEAPIErrors.h file. They are returned by some functions upon an error condition.IDE_NO_ERROR 0IDE_INVALID_PORT_NO

Exerciser Command Parameters40Exerciser Command ParametersThe following exerciser commands require no parameters. These commands do not use vtParam1,

Exerciser Command Parameters41The following exerciser commands use vtParam1:API_EXR_COMMAND_GET_DESCRIPTOR - vtParam1 should be a short variable that

Exerciser Command Parameters42

ContentsvIsDeviceHub - - - - - - - - - - - - - - - - - - - - - - - - - - - -27SetStartExerciserWith - - - - - - - -

ContentsviEndpoint Direction Definitions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 38Exerciser Start With event definition -

Introduction1IntroductionThe Conquest™ Application Program Interface (API) is a collection (library) of COM objects. The API enables programmers to us

IUsbGeneral Services Interface2IUsbGeneral Services InterfaceSetPortDeclaration: long SetPort(short sPortType)Input(s): sPortType specifies hardware p

IUsbGeneral Services Interface3SaveOutFilesDeclaration: longSaveOutFiles()Input(s): NoneReturn Value: Zero if the SaveOutFiles was successful. Otherwi