LogClass (GVL) ¶ Log entry classes to specify the severity of a log message. Can be filtered in the logger or in the logger page. Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant LOG_NONE UDINT 16#0 No defined class LOG_INFO UDINT 16#1 Informational message LOG_WARNING UDINT 16#2 Warning LOG_ERROR UDINT 16#4 Error LOG_EXCEPTION UDINT 16#8 Exception LOG_DEBUG UDINT 16#10 Debug LOG_USER_NOTIFY UDINT 16#10000 Log entries are displayed additionally as a message box in the development system LOG_ALL UDINT 16#FFFFFFFF Is only used to filter entries and should not be used to add log entries
LogClose (FUN) ¶ FUNCTION LogClose : RTS_IEC_RESULT <SIL2/> Close the logger InOut: Scope Name Type Comment Return LogClose RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input hLogger RTS_IEC_HANDLE Handle to the logger which was retrieved by LogCreate() or LogOpen(). Use LogConstant.LOG_STD_LOGGER as a pseudo handle to add this log entry to the standard plc logger.
LogConstants (GVL) ¶ Default logger handles InOut: Scope Name Type Initial Comment Constant STD_LOGGER RTS_IEC_HANDLE 0 Pseudo handle to the standard plc logger LOG_STD_LOGGER RTS_IEC_HANDLE STD_LOGGER Pseudo handle to the standard plc logger. Can be used without an open of the logger LOG_INVALID_HANDLE RTS_IEC_HANDLE RTS_INVALID_HANDLE OBSOLETE: Backward compatibility define for an invalid handle
LogCreate (FUN) ¶ FUNCTION LogCreate : RTS_IEC_HANDLE <SIL2/> Create a new logger specified by options InOut: Scope Name Type Comment Return LogCreate RTS_IEC_HANDLE Returns handle to the new logger or RTS_IEC_INVALID_HANDLE Input pOptions POINTER TO LogOptions Pointer to the options pResult POINTER TO RTS_IEC_RESULT Pointer returns the runtime system error code (see CmpErrors.library)
LogDelete (FUN) ¶ FUNCTION LogDelete : RTS_IEC_RESULT <SIL2/> Delete a logger specified by handle InOut: Scope Name Type Comment Return LogDelete RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library) Input hLogger RTS_IEC_HANDLE Handle to the logger which was retrieved by LogCreate() or LogOpen(). Use LogConstant.LOG_STD_LOGGER as a pseudo handle to add this log entry to the standard plc logger.
LogOpen (FUN) ¶ FUNCTION LogOpen : RTS_IEC_HANDLE <SIL2/> Open an existing logger specified by name. InOut: Scope Name Type Comment Return LogOpen RTS_IEC_HANDLE Returns handle to the existing logger or RTS_IEC_INVALID_HANDLE if not exist Input pszName STRING Name of the logger pResult POINTER TO RTS_IEC_RESULT Pointer to error code (see CmpErrors.library)
LogOptions (STRUCT) ¶ TYPE LogOptions : STRUCT Options of a logger (part of the configuration). InOut: Name Type Comment szName STRING(31) Name of logger bEnable DINT Logger active/inactive uiType UDINT See LogTypes for details uiFilter UDINT Log filter. It is a combination of LogClass iMaxEntries DINT Maximum number of lg entries iMaxFileSize DINT Max file size (if the backend is dumping in a file) iMaxFiles DINT Max number of files (if the backend is dumping in a file)
LogTypes (GVL) ¶ Types / properties of a logger Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant LT_HIGHSPEED UDINT 16#1 Not supported yet LT_SAFE UDINT 16#2 Not supported yet. Dump log entries in ring buffer residing in retain memory. LT_NORMAL UDINT 16#4 Dump log entries in ring buffer residing in volatile memory (RAM) LT_TIMESTAMP_RTC UDINT 16#10 Use realtime clock for the timestamp LT_TIMESTAMP_RTC_HIGHRES UDINT 16#2000 Use real-time clock with high resolution [ms] for the timestamp LT_TIMESTAMP_MS UDINT 16#20 Use millisecond ticks for the timestamp LT_TIMESTAMP_US UDINT 16#40 Use microsecond ticks for the timestamp LT_TIMESTAMP_NS UDINT 16#80 Use nanosecond ticks for the timestamp LT_NO_DISABLE UDINT 16#100 If this option is set, the logger cannot be disabled LT_DUMP_ASYNC UDINT 16#200 Dump asynchronously in the backends LT_DUMP_ALWAYS UDINT 16#400 Dump into the backends at every log entry LT_DUMP_ON_CLOSE UDINT 16#800 Dump only the backends at closing the logger LT_DUMP_ON_REQUEST UDINT 16#1000 Dump can be done by calling LogDumpEntries() LT_STD UDINT (((LT_NORMAL OR LT_TIMESTAMP_RTC) OR LT_NO_DISABLE) OR LT_DUMP_ASYNC) Standard logger settings
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 18.09.2024, 16:35:47 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpLog.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpLog.clean.json version version 2.0.0.0 ProjectInformation LinkInSimulation bool True Released True LastModificationDateTime date 18.09.2024, 16:35:44 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpLog Project CmpLog Title CmpLog Version version 3.5.20.30
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 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)