File ziAPI.h

Header File for the LabOne C/C++ API.

ziAPI provides all functionality to establish a connection with the Data Server and to communicate with it. It has functions for setting and getting parameters in a single call as well as an event-framework with which the user may subscribe the parameter tree and receive the events which occur when values change.

• All functions do not check passed pointers if they’re NULL pointers. In that case a segmentation fault will occur.

• The ZIConnection is not thread-safe. One connection can only be used in one thread. If you want to use the ziAPI in a multi-threaded program you will have to use one ZIConnection for each thread that is communicating or implement a mutual exclusion.

• The Data Server is able to handle connections from threads simultaneously. The Data Server takes over the synchronization.

Source

• Source ziAPI.h

Includes

• wchar.h

Defines

• Define DEPRECATED
• Define DEPRECATED_ENUM
• Define MAX_EVENT_SIZE
• Define MAX_NAME_LEN
• Define MAX_PATH_LEN
• Define TREE_ACTION_cast
• Define ZIListNodes_enum_cast
• Define ZIResult_enum_cast
• Define ZIValueType_enum_cast
• Define ZI_ERROR
• Define ZI_EXPORT

Enums

• Enum TREE_ACTION
• Enum ZIAPIVersion_enum
• Enum ZIChunkHeaderFlags_enum
• Enum ZIChunkHeaderModuleFlags_enum
• Enum ZIDeviceStatus_enum
• Enum ZIImpFlags_enum
• Enum ZIListNodes_enum
• Enum ZIResult_enum
• Enum ZIScopeSampleFormatMask_enum
• Enum ZIScopeSampleFormat_enum
• Enum ZITreeAction_enum
• Enum ZIValueType_enum
• Enum ZIVectorElementType_enum

Typedefs

• Typedef AuxInSample
• Typedef ByteArrayData
• Typedef DIOSample
• Typedef DemodSample
• Typedef ScopeWave
• Typedef TREE_ACTION
• Typedef TreeChange
• Typedef ZIAPIVersion_enum
• Typedef ZIAdvisorHeader
• Typedef ZIAdvisorSample
• Typedef ZIAdvisorWave
• Typedef ZIAsyncReply
• Typedef ZIAsyncTag
• Typedef ZIAuxInSample
• Typedef ZIByteArray
• Typedef ZIByteArrayTS
• Typedef ZIChunkHeader
• Typedef ZICntSample
• Typedef ZICompileResult
• Typedef ZIComplexData
• Typedef ZIConnection
• Typedef ZIDIOSample
• Typedef ZIDemodSample
• Typedef ZIDoubleData
• Typedef ZIDoubleDataTS
• Typedef ZIEvent
• Typedef ZIImpFlags_enum
• Typedef ZIImpedanceSample
• Typedef ZIIntegerData
• Typedef ZIIntegerDataTS
• Typedef ZIListNodes_enum
• Typedef ZIModuleEvent
• Typedef ZIModuleEventPtr
• Typedef ZIModuleHandle
• Typedef ZIPWASample
• Typedef ZIPWAWave
• Typedef ZIResult_enum
• Typedef ZIScopeWave
• Typedef ZIScopeWaveEx
• Typedef ZISpectrumDemodSample
• Typedef ZISpectrumHeader
• Typedef ZISpectrumWave
• Typedef ZIStatisticSample
• Typedef ZISweeperDemodSample
• Typedef ZISweeperDoubleSample
• Typedef ZISweeperHeader
• Typedef ZISweeperImpedanceSample
• Typedef ZISweeperWave
• Typedef ZITimeStamp
• Typedef ZITreeChangeData
• Typedef ZITrigSample
• Typedef ZIValueType_enum
• Typedef ZIVectorData
• Typedef ZIVectorElementType_enum
• Typedef ZI_STATUS
• Typedef ziAPIDataType
• Typedef ziConnection
• Typedef ziDoubleType
• Typedef ziIntegerType
• Typedef ziTimeStampType

Functions

• Function ReadMEMFile
• Function ziAPIAllocateCompileResult
• Function ziAPIAllocateEventEx
• Function ziAPIAsyncGetValueAsPollData
• Function ziAPIAsyncSetByteArray
• Function ziAPIAsyncSetDoubleData
• Function ziAPIAsyncSetIntegerData
• Function ziAPIAsyncSetString
• Function ziAPIAsyncSetStringUnicode
• Function ziAPIAsyncSubscribe
• Function ziAPIAsyncUnSubscribe
• Function ziAPIBeginTransaction
• Function ziAPICompileSeqC
• Function ziAPIConnect
• Function ziAPIConnectDevice
• Function ziAPIConnectEx
• Function ziAPIDeallocateCompileResult
• Function ziAPIDeallocateEventEx
• Function ziAPIDestroy
• Function ziAPIDisconnect
• Function ziAPIDisconnectDevice
• Function ziAPIDiscoveryFind
• Function ziAPIDiscoveryFindAll
• Function ziAPIDiscoveryGet
• Function ziAPIDiscoveryGetValueI
• Function ziAPIDiscoveryGetValueS
• Function ziAPIEchoDevice
• Function ziAPIEndTransaction
• Function ziAPIGetAuxInSample
• Function ziAPIGetCommitHash
• Function ziAPIGetComplexData
• Function ziAPIGetConnectionAPILevel
• Function ziAPIGetDIOSample
• Function ziAPIGetDemodSample
• Function ziAPIGetError
• Function ziAPIGetLastError
• Function ziAPIGetRevision
• Function ziAPIGetValueAsPollData
• Function ziAPIGetValueB
• Function ziAPIGetValueD
• Function ziAPIGetValueI
• Function ziAPIGetValueString
• Function ziAPIGetValueStringUnicode
• Function ziAPIGetVersion
• Function ziAPIInit
• Function ziAPIListImplementations
• Function ziAPIListNodes
• Function ziAPIListNodesJSON
• Function ziAPIModClear
• Function ziAPIModCreate
• Function ziAPIModEventDeallocate
• Function ziAPIModExecute
• Function ziAPIModFinish
• Function ziAPIModFinished
• Function ziAPIModGetChunk
• Function ziAPIModGetDouble
• Function ziAPIModGetInteger
• Function ziAPIModGetString
• Function ziAPIModGetStringUnicode
• Function ziAPIModGetVector
• Function ziAPIModListNodes
• Function ziAPIModListNodesJSON
• Function ziAPIModNextNode
• Function ziAPIModProgress
• Function ziAPIModRead
• Function ziAPIModSave
• Function ziAPIModSetByteArray
• Function ziAPIModSetDoubleData
• Function ziAPIModSetIntegerData
• Function ziAPIModSetString
• Function ziAPIModSetStringUnicode
• Function ziAPIModSetVector
• Function ziAPIModSubscribe
• Function ziAPIModTrigger
• Function ziAPIModUnSubscribe
• Function ziAPIPollDataEx
• Function ziAPISecondsTimeStamp
• Function ziAPISetComplexData
• Function ziAPISetDebugLevel
• Function ziAPISetValueB
• Function ziAPISetValueD
• Function ziAPISetValueI
• Function ziAPISetValueString
• Function ziAPISetValueStringUnicode
• Function ziAPISetVector
• Function ziAPISubscribe
• Function ziAPISync
• Function ziAPISyncSetValueB
• Function ziAPISyncSetValueD
• Function ziAPISyncSetValueI
• Function ziAPISyncSetValueString
• Function ziAPISyncSetValueStringUnicode
• Function ziAPITransactionalSetBytes
• Function ziAPITransactionalSetComplex
• Function ziAPITransactionalSetDouble
• Function ziAPITransactionalSetInt
• Function ziAPITransactionalSetVector
• Function ziAPIUnSubscribe
• Function ziAPIUpdateDevices
• Function ziAPIWriteDebugLog

Structs

• Struct AuxInSample
• Struct ByteArrayData
• Struct DIOSample
• Struct DemodSample
• Struct ScopeWave
• Struct TreeChange
• Struct ZIAdvisorHeader
• Struct ZIAdvisorSample
• Struct ZIAdvisorWave
• Struct ZIAsyncReply
• Struct ZIAuxInSample
• Struct ZIByteArray
• Struct ZIByteArrayTS
• Struct ZIChunkHeader
• Struct ZICntSample
• Struct ZICompileResult
• Struct ZIComplexData
• Struct ZIDIOSample
• Struct ZIDemodSample
• Struct ZIDoubleDataTS
• Struct ZIEvent
• Struct ZIImpedanceSample
• Struct ZIIntegerDataTS
• Struct ZIModuleEvent
• Struct ZIPWASample
• Struct ZIPWAWave
• Struct ZIScopeWave
• Struct ZIScopeWaveEx
• Struct ZISpectrumDemodSample
• Struct ZISpectrumHeader
• Struct ZISpectrumWave
• Struct ZIStatisticSample
• Struct ZISweeperDemodSample
• Struct ZISweeperDoubleSample
• Struct ZISweeperHeader
• Struct ZISweeperImpedanceSample
• Struct ZISweeperWave
• Struct ZITreeChangeData
• Struct ZITrigSample
• Struct ZIVectorData