File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 03.07.2018, 10:34:40 companyName string 3S-Smart Software Solutions GmbH libraryFile SysEvent23.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP13 contentFile SysEvent23.clean.json version version 2.0.0.0 ProjectInformation Released bool True Support32BitOnly True LastModificationDateTime date 03.07.2018, 10:34:40 LibraryCategories library-category-list System|SysLibs23 Author string 3S - Smart Software Solutions GmbH Company System Description See: Description Project SysEvent23 Title SysEvent23 Version version 3.5.13.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
SysExcept Library Documentation ¶ Company System Title SysExcept Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder SysExcept Description 1 ¶ Library, to handle exceptions in IEC. Contents: ¶ RegContext (Struct) RtsExceptions (GVL) SysExceptGenerateException (Function) Indices and tables ¶ 1 Based on SysExcept.library, last modified 20.04.2021, 16:03:24. LibDoc 4.4.0.0-b.27 The content file SysExcept.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:03:24.
RtsExceptions (GVL) ¶ <category>Exception codes</category> InOut: Scope Name Type Initial Comment Constant RTSEXCPT_UNKNOWN UDINT SINT_TO_UDINT(-1) <category>Exception code</category> <description>No exception</description> RTSEXCPT_NOEXCEPTION UDINT 16#0 <category>Exception code</category> <description>No exception</description> RTSEXCPT_WATCHDOG UDINT 16#10 <category>Exception code</category> <description>Software watchdog of IEC-task expired</description> RTSEXCPT_HARDWAREWATCHDOG UDINT 16#11 <category>Exception code</category> <description>Hardware watchdog expired. Global software error</description> RTSEXCPT_IO_CONFIG_ERROR UDINT 16#12 <category>Exception code</category> <description>IO config error</description> RTSEXCPT_PROGRAMCHECKSUM UDINT 16#13 <category>Exception code</category> <description>Checksum error after program download</description> RTSEXCPT_FIELDBUS_ERROR UDINT 16#14 <category>Exception code</category> <description>Fieldbus error</description> RTSEXCPT_IOUPDATE_ERROR UDINT 16#15 <category>Exception code</category> <description>IO-update error</description> RTSEXCPT_CYCLE_TIME_EXCEED UDINT 16#16 <category>Exception code</category> <description>Cycle time exceed</description> RTSEXCPT_ONLCHANGE_PROGRAM_EXCEEDED UDINT 16#17 <category>Exception code</category> <description>Online change program too large</description> RTSEXCPT_UNRESOLVED_EXTREFS UDINT 16#18 <category>Exception code</category> <description>Unresolved external references</description> RTSEXCPT_DOWNLOAD_REJECTED UDINT 16#19 <category>Exception code</category> <description>Download was rejected</description> RTSEXCPT_BOOTPROJECT_REJECTED_DUE_RETAIN_ERROR UDINT 16#1A <category>Exception code</category> <description>Boot project not loaded because retain variables could not be relocated</description> RTSEXCPT_LOADBOOTPROJECT_FAILED UDINT 16#1B <category>Exception code</category> <description>Boot project not loaded and deleted</description> RTSEXCPT_OUT_OF_MEMORY UDINT 16#1C <category>Exception code</category> <description>Out of heap memory</description> RTSEXCPT_RETAIN_MEMORY_ERROR UDINT 16#1D <category>Exception code</category> <description>Retain memory corrupt or cannot be mapped</description> RTSEXCPT_BOOTPROJECT_CRASH UDINT 16#1E <category>Exception code</category> <description>Boot project that could be loaded but caused a crash later</description> RTSEXCPT_BOOTPROJECTTARGETMISMATCH UDINT 16#21 <category>Exception code</category> <description>Target of the bootproject doesn’t match the current target</description> RTSEXCPT_SCHEDULEERROR UDINT 16#22 <category>Exception code</category> <description>Error at scheduling tasks</description> RTSEXCPT_FILE_CHECKSUM_ERR UDINT 16#23 <category>Exception code</category> <description>Checksum of downloaded file does not match</description> RTSEXCPT_RETAIN_IDENTITY_MISMATCH UDINT 16#24 <category>Exception code</category> <description>Retain identity does not match to current bootproject program identity</description> RTSEXCPT_IEC_TASK_CONFIG_ERROR UDINT 16#25 <category>Exception code</category> <description>Iec task configuration failed</description> RTSEXCPT_APP_TARGET_MISMATCH UDINT 16#26 <category>Exception code</category> <description>Application is running on wrong target. Can be used for library protection!</description> RTSEXCPT_ILLEGAL_INSTRUCTION UDINT 16#50 <category>Exception code, hardware exceptions</category> <description>Illegal instruction</description> RTSEXCPT_ACCESS_VIOLATION UDINT 16#51 <category>Exception code, hardware exceptions</category> <description>Access violation</description> RTSEXCPT_PRIV_INSTRUCTION UDINT 16#52 <category>Exception code, hardware exceptions</category> <description>Privileged instruction</description> RTSEXCPT_IN_PAGE_ERROR UDINT 16#53 <category>Exception code, hardware exceptions</category> <description>Page fault</description> RTSEXCPT_STACK_OVERFLOW UDINT 16#54 <category>Exception code, hardware exceptions</category> <description>Stack overflow</description> RTSEXCPT_INVALID_DISPOSITION UDINT 16#55 <category>Exception code, hardware exceptions</category> <description>Invalid disposition</description> RTSEXCPT_INVALID_HANDLE UDINT 16#56 <category>Exception code, hardware exceptions</category> <description>Invalid handle</description> RTSEXCPT_GUARD_PAGE UDINT 16#57 <category>Exception code, hardware exceptions</category> <description>Guard page</description> RTSEXCPT_DOUBLE_FAULT UDINT 16#58 <category>Exception code, hardware exceptions</category> <description>Double fault</description> RTSEXCPT_INVALID_OPCODE UDINT 16#59 <category>Exception code, hardware exceptions</category> <description>Invalid OpCode</description> RTSEXCPT_MISALIGNMENT UDINT 16#100 <category>Exception code, hardware exceptions</category> <description>Datatype misalignment</description> RTSEXCPT_ARRAYBOUNDS UDINT 16#101 <category>Exception code, hardware exceptions</category> <description>Array bounds exceeded</description> RTSEXCPT_DIVIDEBYZERO UDINT 16#102 <category>Exception code, hardware exceptions</category> <description>Division by zero</description> RTSEXCPT_OVERFLOW UDINT 16#103 <category>Exception code, hardware exceptions</category> <description>Overflow</description> RTSEXCPT_NONCONTINUABLE UDINT 16#104 <category>Exception code, hardware exceptions</category> <description>Non continuable</description> RTSEXCPT_PROCESSORLOAD_WATCHDOG UDINT 16#105 <category>Exception code</category> <description>Processor load watchdog of all IEC-tasks detected</description> RTSEXCPT_FPU_ERROR UDINT 16#150 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Unspecified error</description> RTSEXCPT_FPU_DENORMAL_OPERAND UDINT 16#151 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Denormal operand</description> RTSEXCPT_FPU_DIVIDEBYZERO UDINT 16#152 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Division by zero</description> RTSEXCPT_FPU_INEXACT_RESULT UDINT 16#153 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Inexact result</description> RTSEXCPT_FPU_INVALID_OPERATION UDINT 16#154 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Invalid operation</description> RTSEXCPT_FPU_OVERFLOW UDINT 16#155 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Overflow</description> RTSEXCPT_FPU_STACK_CHECK UDINT 16#156 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Stack check</description> RTSEXCPT_FPU_UNDERFLOW UDINT 16#157 <category>Exception code, hardware FPU exceptions</category> <description>FPU: Underflow</description> RTSEXCPT_VENDOR_EXCEPTION_BASE UDINT 16#2000 <category>Exception code, vendor specific</category> <description>Base number for vendor specific exception codes. VendorID must be specified as prefix inside the exception code: unsigned long ulException = ADDVENDORID([VendorId], RTSEXCPT_VENDOR_EXCEPTION_BASE + [Exception]); </description>
RegContext (STRUCT) ¶ TYPE RegContext : STRUCT <category>Exception context</category> InOut: Name Type Comment IP __UXINT <element name=”IP” type=”IN”>Instruction pointer or program counter</element> BP __UXINT <element name=”BP” type=”IN”>Base pointer or frame pointer</element> SP __UXINT <element name=”SP” type=”IN”>Stack pointer</element>
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 16:03:24 companyName string 3S-Smart Software Solutions GmbH libraryFile SysExcept.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysExcept.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 16:03:24 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description Placeholder SysExcept Project SysExcept Title SysExcept Version version 3.5.17.0
SysExceptGenerateException (FUN) ¶ FUNCTION SysExceptGenerateException : RTS_IEC_RESULT <description>Interrupt the execution of the currently running task, and set the application into an exception state. If the runtime system supports it, CODESYS may even highlight the source position where this function was called.</description> <result><p>RESULT: If succeeded this function doesn’t return at all, otherwise it returns ERR_FAILED.</p></result> InOut: Scope Name Type Return SysExceptGenerateException RTS_IEC_RESULT Input udiException UDINT
SysFileGetName2 (FUN) ¶ FUNCTION SysFileGetName2 : POINTER TO STRING Get the file name from file specified by handle InOut: Scope Name Type Comment Return SysFileGetName2 POINTER TO STRING File name of the specified file Input hFile RTS_IEC_HANDLE Handle of the file pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library)
SysFileGetPath (FUN) ¶ FUNCTION SysFileGetPath : RTS_IEC_RESULT Get the path of this file. If a path is specified in the filename, the path will be extracted from the filename. If no path is specified in the filename, the standard path for this file extension type will be returned. InOut: Scope Name Type Comment Return SysFileGetPath RTS_IEC_RESULT The runtime system error code (see CmpErrors.library) Input szFileName STRING File name. Can contain an absolute or relative path Inout szPath STRING Path for this file Input diMaxLen DINT Maximum size in bytes of path length
SysFileGetSize (FUN) ¶ FUNCTION SysFileGetSize : __XWORD Get file size of the file specified by name. A standard path will be added to the filename, if no path is specified. InOut: Scope Name Type Comment Return SysFileGetSize __XWORD Size of the file in bytes Input szFileName STRING File name. File name can contain an absolute or relative path to the file. Path entries must be separated with a Slash (/) and not with a Backslash (\)! pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library): ERR_OK: Successful ERR_NO_OBJECT: File not available ERR_FAILED: Failed to get file size
