Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. IoDrvKnxStack Interfaces ¶ Library Identification ¶ Name: IoDrvKnxStack Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IoDrvKnxStackItfs Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDrvKnxStack Interfaces, * (3S - Smart Software Solutions GmbH)

CmpTraceMgr Library Documentation ¶ Company System Title CmpTraceMgr Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpTraceMgr Description 1 ¶ This library provides access to the runtime system component CmpTraceMgr. The trace manager handles trace packets, that are defined from: the Trace editor in CoDeSys, a runtime system component, or an IEC program. A trace packet is the container for trace variables, which are called records. A trace packet is is always identified by its name, which must be unique. A trace record contains the trace of a single variable, including the buffer used to store the time-stamped samples. This is a typical sequence of function calls a client of CmpTraceMgr will use: TraceMgrPacketCreate TraceMgrRecordAdd TraceMgrPacketComplete TraceMgrPacketStart TraceMgrPacketStop TraceMgrPacketRestart / TraceMgrPacketStart / TraceMgrPacketDelete Contents: ¶ ComponentId (GVL) EventParameter EVTPARAM_CmpTraceMgr_Packet (Struct) EVTPARAM_CmpTraceMgr_Record (Struct) EventIDs (GVL) GlobalConstants (GVL) Structs AddressArea (Struct) Monitoring2ByteCode (Struct) Monitoring2ByteCodeUnion (Union) MonitoringService (Struct) PropertyLocation (Struct) SymVarAccess (Struct) SystemParameter (Struct) TraceAddress (Union) TracePacketConfiguration (Struct) TraceRecordConfiguration (Struct) TraceRecordEntry (Struct) TraceState (Struct) TraceTrigger (Struct) TraceVarInfo (Union) TraceVariable (Struct) TraceVariableAddress (Struct) TriggerState (Struct) TriggerValue (Union) TypeClass3 (Alias) TRACE_PACKET_FLAGS (GVL) TRACE_PACKET_STATE (GVL) TRACE_RECORD_GRAPH_TYPES (GVL) TRACE_TRIGGER_EDGE (GVL) TRACE_TRIGGER_FLAGS (GVL) TRACE_TRIGGER_STATE (GVL) TRACE_VAR_ADDRESS_FLAGS (GVL) TraceMgrGetConfigFromFile (Function) TraceMgrGetConfigFromFileRelease (Function) TraceMgrPacketCheckTrigger (Function) TraceMgrPacketClose (Function) TraceMgrPacketComplete (Function) TraceMgrPacketCreate (Function) TraceMgrPacketDelete (Function) TraceMgrPacketDisable (Function) TraceMgrPacketDisableTrigger (Function) TraceMgrPacketEnable (Function) TraceMgrPacketEnableTrigger (Function) TraceMgrPacketGetAbsoluteStartTime (Function) TraceMgrPacketGetChangeTimestamp (Function) TraceMgrPacketGetConfig (Function) TraceMgrPacketGetFirst (Function) TraceMgrPacketGetNext (Function) TraceMgrPacketGetStartTime (Function) TraceMgrPacketGetState (Function) TraceMgrPacketOpen (Function) TraceMgrPacketReadBegin (Function) TraceMgrPacketReadEnd (Function) TraceMgrPacketReadFirst (Function) TraceMgrPacketReadFirst2 (Function) TraceMgrPacketReadNext (Function) TraceMgrPacketReadNext2 (Function) TraceMgrPacketResetTrigger (Function) TraceMgrPacketRestart (Function) TraceMgrPacketRestore (Function) TraceMgrPacketStart (Function) TraceMgrPacketStop (Function) TraceMgrPacketStore (Function) TraceMgrRecordAdd (Function) TraceMgrRecordGetConfig (Function) TraceMgrRecordGetFirst (Function) TraceMgrRecordGetNext (Function) TraceMgrRecordRemove (Function) TraceMgrRecordUpdate (Function) TraceMgrRecordUpdate2 (Function) TraceMgrRecordUpdate3 (Function) TraceMgrRecordUpdate4 (Function) TraceMgrRecordUpdate5 (Function) Indices and tables ¶ 1 Based on CmpTraceMgr.library, last modified 20.04.2021, 15:57:46. LibDoc 4.4.0.0-b.27 The content file CmpTraceMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:57:46.

TraceMgrPacketCreate (FUN) ¶ FUNCTION TraceMgrPacketCreate : RTS_IEC_HANDLE Creates a new trace packet. The returned handle must be deleted with TraceMgrPacketDelete when the packet is no longer needed. InOut: Scope Name Type Comment Return TraceMgrPacketCreate RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if pConfiguration.pszName is 0 ERR_DUPLICATE if a packet with the given name already exists ERR_NOMEMORY if the available memory is not sufficient to create the packet Inout pConfiguration TracePacketConfiguration The trace packet configuration (in) pResult RTS_IEC_RESULT The result code (out)

TraceMgrPacketDelete (FUN) ¶ FUNCTION TraceMgrPacketDelete : RTS_IEC_RESULT Deletes an existing handle. The handle must have been created with TraceMgrPacketCreate. InOut: Scope Name Type Comment Return TraceMgrPacketDelete RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketDisable (FUN) ¶ FUNCTION TraceMgrPacketDisable : RTS_IEC_RESULT Disables a trace packet. Does nothing if the trace packet is disabled. InOut: Scope Name Type Comment Return TraceMgrPacketDisable RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketOpen (FUN) ¶ FUNCTION TraceMgrPacketOpen : RTS_IEC_HANDLE Opens a trace packet specified by name. Note Comparison of packet names is case-insensitive. InOut: Scope Name Type Comment Return TraceMgrPacketOpen RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_NO_OBJECT if no packet with the given name is found. Inout Const pszName STRING The name of the trace packet to open (in) Inout pResult RTS_IEC_RESULT The result code (out)

TraceMgrPacketReadBegin (FUN) ¶ FUNCTION TraceMgrPacketReadBegin : RTS_IEC_RESULT Start reading trace packet. The purpose of this function is to trigger the event EVT_TRACEMGR_PACKET_SAMPLE. In response to the event, any outstanding trace samples will be written by runtime system components and IEC applications that provide trace values for system parameters. Note Normally, there is no need to call this function. It should be called before TraceMgrPacketReadFirst and TraceMgrPacketReadFirst2 to make sure all trace values are present before reading. When finished with reading, TraceMgrPacketReadEnd should be called. InOut: Scope Name Type Comment Return TraceMgrPacketReadBegin RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NOTINITIALIZED if hPacket is not complete and started Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketReadEnd (FUN) ¶ FUNCTION TraceMgrPacketReadEnd : RTS_IEC_RESULT End reading trace packet. See description of function TraceMgrPacketReadBegin . InOut: Scope Name Type Comment Return TraceMgrPacketReadEnd RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NOTINITIALIZED if hPacket is not complete and started Input hPacket RTS_IEC_HANDLE The trace packet handle

TraceMgrPacketReadFirst (FUN) ¶ FUNCTION TraceMgrPacketReadFirst : RTS_IEC_HANDLE Reads the contents of the first record. Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note You should call TraceMgrPacketReadBegin before calling this function, to make sure any outstanding trace values are written to the trace buffers. Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadFirst RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NO_OBJECT if the packet does not have a single record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code

TraceMgrPacketReadFirst2 (FUN) ¶ FUNCTION TraceMgrPacketReadFirst2 : RTS_IEC_HANDLE Reads the contents of the first record, starting at a given time stamp. Only entries with a time stamp greater than or equal to ulTimestamp are copied. If the time stamp is zero, the function behaves like TraceMgrPacketReadFirst . Note if the result code is ERR_ENTRIES_REMAINING, data has been successfully copied to pTraceBuffer, but more data can be read by a subsequent call. (Either because the destination buffer was too small, or because new data has been recorded in the mean time.) Note You should call TraceMgrPacketReadBegin before calling this function, to make sure any outstanding trace values are written to the trace buffers. Note Data is always returned in little endian byte order even if the device has big endian byte order. InOut: Scope Name Type Comment Return TraceMgrPacketReadFirst2 RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket is not a valid packet handle ERR_NO_OBJECT if the packet does not have a single record ERR_NOTINITIALIZED if the packet is not complete ERR_TIMEOUT if reading took too long ERR_ENTRIES_REMAINING if more data can be read by a subsequent call (this is not an error) Input hPacket RTS_IEC_HANDLE The trace packet handle ulTimestamp UDINT The time stamp (relative to the trace start time) from where to start copying Inout pTraceBuffer TraceRecordEntry Pointer to the destination buffer pulReadBytes UDINT Size of the destination buffer in bytes (in), number of bytes copied (out) pResult RTS_IEC_RESULT The result code