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
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) IecVarAccess3 Interfaces ¶ Library Identification ¶ Name: IecVarAccess3 Interfaces Version: newest Company: System Namespace: IecVarAccess_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IecVarAccess3 Interfaces, * (System) SysTime ¶ Library Identification ¶ Placeholder: SysTime Default Resolution: SysTime, * (System) Namespace: SysTime Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTime SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
CmpUserMgr Implementation Library Documentation ¶ Company System Title CmpUserMgr Implementation Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpUserMgr Implementation Description 1 ¶ This library contains the implementation used to access the user management of the runtime system as external functions to the CmpUserMgr component. Contents: ¶ CmpUserMgr Functions Indices and tables ¶ 1 Based on CmpUserMgr Implementation.library, last modified 02.03.2023, 11:02:39. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:02:41.
TraceMgrPacketGetState (FUN) ¶ FUNCTION TraceMgrPacketGetState : RTS_IEC_RESULT Returns the state of a trace packet. InOut: Scope Name Type Comment Return TraceMgrPacketGetState 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 Inout pState TraceState The packet state (out)
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