TraceMgrRecordGetConfig (FUN) ¶ FUNCTION TraceMgrRecordGetConfig : RTS_IEC_RESULT Queries the configuration of a trace record. InOut: Scope Name Type Comment Return TraceMgrRecordGetConfig RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hRecord is not a valid handle Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle Inout pConfiguration TraceRecordConfiguration The trace record configuration (out)

TraceMgrRecordGetFirst (FUN) ¶ FUNCTION TraceMgrRecordGetFirst : RTS_IEC_HANDLE Returns the first trace record of a trace packet. This function can be used together with TraceMgrRecordGetNext to iterate through all trace records of a packet. InOut: Scope Name Type Comment Return TraceMgrRecordGetFirst 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 has no trace record Input hPacket RTS_IEC_HANDLE The trace packet handle Inout pResult RTS_IEC_RESULT The result code (out)

TraceMgrRecordGetNext (FUN) ¶ FUNCTION TraceMgrRecordGetNext : RTS_IEC_HANDLE Returns the next trace record of a trace packet. This function can be used together with TraceMgrRecordGetFirst to iterate through all trace records of a packet. InOut: Scope Name Type Comment Return TraceMgrRecordGetNext RTS_IEC_HANDLE Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NO_OBJECT if the packet has no next trace record Input hPacket RTS_IEC_HANDLE The trace packet handle hPrevRecord RTS_IEC_HANDLE The trace record handle of the current record Inout pResult RTS_IEC_RESULT The result code (out)

TraceMgrRecordRemove (FUN) ¶ FUNCTION TraceMgrRecordRemove : RTS_IEC_RESULT Removes a trace record from a trace packet. InOut: Scope Name Type Comment Return TraceMgrRecordRemove RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if the packet handle or the record handle is invalid Input hPacket RTS_IEC_HANDLE The packet handle hRecord RTS_IEC_HANDLE The record handle

TraceMgrRecordUpdate (FUN) ¶ FUNCTION TraceMgrRecordUpdate : RTS_IEC_RESULT Records the current value of the trace variable of a record together with the current time stamp. Note This function is called cyclically by CmpTraceMgr. It should not be called by the application. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles ERR_FAILED if reading the value of the trace variable failed Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle

TraceMgrRecordUpdate2 (FUN) ¶ FUNCTION TraceMgrRecordUpdate2 : RTS_IEC_RESULT Stores entries in the ring buffer of a trace record. This function can be used to provide the data for so called system parameters from the IEC application. (See TRACE_VAR_ADDRESS_FLAGS_SYSTEM .) If only a single entry is to be added, consider using TraceMgrRecordUpdate3 instead. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate2 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles ERR_FAILED if ulLen is not a multiple of the entry size (size of a time stamp plus a sample value) Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle Inout pBuffer TraceRecordEntry A pointer to the buffer of trace entries Input ulLen UDINT The number of bytes to copy from pBuffer

TraceMgrRecordUpdate3 (FUN) ¶ FUNCTION TraceMgrRecordUpdate3 : RTS_IEC_RESULT Stores one entry in the ring buffer of a trace record. This function can be used to provide the data for so called system parameters from the IEC application. (See TRACE_VAR_ADDRESS_FLAGS_SYSTEM .) If more than one single entry is to be added, consider using TraceMgrRecordUpdate2 instead. Note in contrast to TraceMgrRecordUpdate2 , the time stamp of the entry is not provided by the caller but set inside TraceMgrRecordUpdate3 . Note If pData is 0, the current value of the trace variable is read, i.e. the function behaves TraceMgrRecordUpdate. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate3 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle, or if ulLen differs from the size of the trace variable ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles ERR_FAILED if pData is 0 and the current value of the trace variable cannot be read Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle pData POINTER TO BYTE The address of the variable value to copy, if pData is null the function behaves like TraceMgrRecordUpdate ulLen UDINT The length (in bytes) of the variable value

TraceMgrRecordUpdate4 (FUN) ¶ FUNCTION TraceMgrRecordUpdate4 : RTS_IEC_RESULT Stores multiple values with seperate timestamps in the ring buffer of a trace record. This function can be used to provide the data for so called system parameters from the IEC application. (See TRACE_VAR_ADDRESS_FLAGS_SYSTEM .) Note in contrast to TraceMgrRecordUpdate2 , the timestamp of the values and the values itself are provided in seperate lists by the caller. Note the number of timestamps must be the same as the number of data values. ulEntries must match to this number. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate4 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle pTimestamps POINTER TO UDINT The address of the first timestamp of the variable values pDataValues POINTER TO BYTE The address of the first variable value of the list to copy ulEntries UDINT The number of variables to be updated

TraceMgrRecordUpdate5 (FUN) ¶ FUNCTION TraceMgrRecordUpdate5 : RTS_IEC_RESULT Records the current value of the trace variable of a record. For all trace records in the context of an IEC or system task, we use one timestamp for all values [CDS-66118]. Note This function is called cyclically by CmpTraceMgr. It should not be called by the application. InOut: Scope Name Type Comment Return TraceMgrRecordUpdate5 RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_PARAMETER if hPacket or hPrevRecord is not a valid handle ERR_NOTINITIALIZED if the packet is not currently recording (not started, trigger reached, …) ERR_PENDING if no value is recorded for this cycle due to TracePacketConfiguration.ulEveryNCycles ERR_FAILED if reading the value of the trace variable failed Input hPacket RTS_IEC_HANDLE The trace packet handle hRecord RTS_IEC_HANDLE The trace record handle pstTimestamp POINTER TO SYSTIME The address of the timestamp of the variable values

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:57:46 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTraceMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTraceMgr.clean.json version version 2.0.0.0 ProjectInformation LinkInSimulation bool True Released True LastModificationDateTime date 20.04.2021, 15:57:46 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpTraceMgr Project CmpTraceMgr Title CmpTraceMgr Version version 3.5.17.0