UtilIsToSwap (FUN) ¶ FUNCTION UtilIsToSwap : BOOL InOut: Scope Name Type Return UtilIsToSwap BOOL Input bo IDatasources.ByteOrder
UtilsWriteBYTE (FUN) ¶ FUNCTION UtilsWriteBYTE : UDINT Writes a BYTE to an IServiceWriter instance. InOut: Scope Name Type Comment Return UtilsWriteBYTE UDINT 0 if the processing was successful. Input itfServiceWriter IServiceWriter The IServiceWriter instance, where the data has to be written to uiTag UINT The tag used for identifying the data byValue BYTE The BYTE value, that has to be written
UtilsWriteString (FUN) ¶ FUNCTION UtilsWriteString : UDINT Writes a string to an IServiceWriter instance. The return value indicates, whether the processing was successful (0) or not. InOut: Scope Name Type Comment Return UtilsWriteString UDINT Input itfWriter IServiceWriter The IServiceWriter instance, where the data has to be written to uiTag UINT The tag used for identifying the data psz POINTER TO STRING(255) Points to the string, that has to be written
CmpErrors2 Interfaces Library Documentation ¶ Company System Title CmpErrors2 Interfaces Version 3.5.19.0 Categories System|SysLibs Namespace CmpErrors Author 3S - Smart Software Solutions GmbH Description 1 ¶ Library, that contains all error codes that are returned by the target. Contents: ¶ Errors (GVL) Indices and tables ¶ 1 Based on CmpErrors2_Itfs.library, last modified 02.03.2023, 11:01:37. LibDoc 4.4.0.0-b.27 The content file CmpErrors2_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:01:39.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:01:39 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpErrors2_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpErrors2_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True LastModificationDateTime date 02.03.2023, 11:01:37 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace CmpErrors Description See: Description DocFormat reStructuredText Project CmpErrors2_Itfs Title CmpErrors2 Interfaces Version version 3.5.19.0
Errors (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant ERR_OK UDINT 16#0 Ok ERR_FAILED UDINT 16#1 General error - to be used only for internal errors ERR_PARAMETER UDINT 16#2 Invalid parameter for this operation ERR_NOTINITIALIZED UDINT 16#3 Function cannot be executed, since component has not been initialized yet. It may work later, though ERR_VERSION UDINT 16#4 Version conflict ERR_TIMEOUT UDINT 16#5 Operation timed out ERR_NOBUFFER UDINT 16#6 Insufficient memory to carry out the request ERR_PENDING UDINT 16#A For async-calls: call not complete, yet ERR_NUMPENDING UDINT 16#B To many pending calls. Try later ERR_NOTIMPLEMENTED UDINT 16#C The function is not implemented ERR_INVALIDID UDINT 16#D No object with the provided id found ERR_OVERFLOW UDINT 16#E Integer overflow ERR_BUFFERSIZE UDINT 16#F The size of a buffer is to small or invalid ERR_NO_OBJECT UDINT 16#10 No object with this specified name available ERR_NOMEMORY UDINT 16#11 No heap memory available ERR_DUPLICATE UDINT 16#12 An object with the same name is still available ERR_MEMORY_OVERWRITE UDINT 16#13 Heap memory was written out of bounds! Memory overwrite error ERR_INVALID_HANDLE UDINT 16#14 Invalid handle TO an object ERR_END_OF_OBJECT UDINT 16#15 End OF object reached ERR_NO_CHANGE UDINT 16#16 No changes done ERR_INVALID_INTERFACE UDINT 16#17 Invalid OR unknown INTERFACE ERR_NOT_SUPPORTED UDINT 16#18 Functionality NOT supported ERR_NO_ACCESS_RIGHTS UDINT 16#19 No access rights FOR THIS operation ERR_OUT_OF_LIMITS UDINT 16#1A Specified limits OF a resource exceeded ERR_ENTRIES_REMAINING UDINT 16#1B Remaining entries that could NOT be transmitted because OF buffer limitation ERR_INVALID_SESSION_ID UDINT 16#1C Invalid online sessionid ERR_EXCEPTION UDINT 16#1D Exception occurred ERR_SIGNATURE_MISMATCH UDINT 16#1E Signature mismatch OF an api FUNCTION ERR_VERSION_MISMATCH UDINT 16#1F Version mismatch ERR_TYPE_MISMATCH UDINT 16#20 TYPE mismatch ERR_ID_MISMATCH UDINT 16#21 ID mismatch ERR_NO_CONSISTENCY UDINT 16#22 Consistency error ERR_NO_COMM_CYCLE UDINT 16#23 No COMM_CYCLE needed ERR_DONT_SUSPEND_TASK UDINT 16#24 DO NOT suspend task after an exception ERR_MEMORY_LOCK_FAILED UDINT 16#25 Memory cannot be locked in THIS operation ERR_LICENSE_MISSING UDINT 16#26 License missing FOR the runtime ERR_OPERATION_DENIED UDINT 16#27 Operation denied ERR_DEVICE UDINT 16#28 Device error ERR_DISK_FULL UDINT 16#29 Disk full ERR_CRC_FAILED UDINT 16#30 Internal use in runtime ERR_MEDIA_ERASE UDINT 16#31 Internal use in runtime ERR_FILE_ERROR UDINT 16#32 File error. e.g. cannot open a file FOR writing because it could be write PROTECTED ERR_NO_RETAIN_MEMORY UDINT 16#33 No RETAIN memory available ERR_OUT_OF_LIMITS_MIN UDINT 16#34 Specified minimum-limit of a resource exceeded ERR_OUT_OF_LIMITS_MAX UDINT 16#35 Specified maximum-limit of a resource exceeded ERR_SIZE_MISMATCH UDINT 16#36 Size mismatch ERR_CALL_AGAIN UDINT 16#37 Operation is not yet finished, call function again to proceed ERR_NOTHING_TO_DO UDINT 16#38 Operation has nothing TO DO. No execution. ERR_SECURITY_CHECKS_FAILED UDINT 16#39 Some security checks have failed. THIS is a generic error code TO report THIS error over PUBLIC channels. In THIS CASE the error code doesn’t provide a detailed cause for the error. * / ERR_INVALID_SEQUENCE UDINT 16#3A ERR_INVALID_REFERENCE UDINT 16#3B Dereferencing an IEC reference in IecVarAccess failed due to invalid destination address, e. G. NULL. ERR_CONVERSION_INCOMPLETE UDINT 16#3C Conversion of string encodings was not lossless. ERR_SOCK_NOTINITIALIZED UDINT 16#201 Socket not initialized ERR_SOCK_NOTSOCKET UDINT 16#202 The provided socket handle is invalid ERR_SOCK_AFUNSUPPORTED UDINT 16#203 The address family is NOT supported ERR_SOCK_PROTOUNSUPPORTED UDINT 16#204 Protocol is NOT supported ERR_SOCK_NOBUFFER UDINT 16#205 NOT enough buffer TO handle the request ERR_SOCK_WOULDBLOCK UDINT 16#206 Socket is in nonblocking mode but THIS call would block ERR_SOCK_ADDRINUSE UDINT 16#207 The provided address is already in use ERR_SOCK_ADDRNOTAVAILABLE UDINT 16#208 The provided address is NOT available on THIS computer ERR_SOCK_CONNREFUSED UDINT 16#209 Connection has been refused BY the remote host ERR_SOCK_TIMEDOUT UDINT 16#20A Operation timed out ERR_SOCK_HOSTNOTFOUND UDINT 16#20B The host has NOT been found ERR_SOCK_HOSTUNREACHABLE UDINT 16#20C Host is unreachable ERR_SOCK_ISCONNECTED UDINT 16#20D Socket is already connected ERR_SOCK_NOTCONNECTED UDINT 16#20E The socket is NOT connected ERR_SOCK_SHUTDOWN UDINT 16#20F Shutdown has been called on the socket ERR_SOCK_MSGSIZE UDINT 16#210 FOR sockets OF TYPE DGRAM. The package TO send exceeds the maximum package size ERR_SOCK_CLOSED UDINT 16#211 Socket has been gracefully closed. No more send/receives allowed ERR_L7_TAG_MISSING UDINT 16#300 Tag missing in online communication buffer ERR_L7_UNKNOWNCMDGROUP UDINT 16#301 Unknown command group ERR_L7_UNKNOWNCMD UDINT 16#302 Unknown command (within a valid command group) ERR_L7_INCOMPLETE UDINT 16#303 Level 7 service incomplete ERR_CERT_OK UDINT ERR_OK Certificate validation error codes ERR_CERT_UNABLE_TO_GET_ISSUER_CERT UDINT 16#701 illegal error (FOR uninitialized values, TO avoid ERR_CERT_OK) * / ERR_CERT_UNABLE_TO_GET_CRL UDINT 16#702 ERR_CERT_UNABLE_TO_DECRYPT_CERT_SIGNATURE UDINT 16#703 ERR_CERT_UNABLE_TO_DECRYPT_CRL_SIGNATURE UDINT 16#704 ERR_CERT_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY UDINT 16#705 ERR_CERT_SIGNATURE_FAILURE UDINT 16#706 ERR_CERT_CRL_SIGNATURE_FAILURE UDINT 16#707 ERR_CERT_NOT_YET_VALID UDINT 16#708 ERR_CERT_HAS_EXPIRED UDINT 16#709 ERR_CERT_CRL_NOT_YET_VALID UDINT 16#70A ERR_CERT_CRL_HAS_EXPIRED UDINT 16#70B ERR_CERT_ERROR_IN_CERT_NOT_BEFORE_FIELD UDINT 16#70C ERR_CERT_ERROR_IN_CERT_NOT_AFTER_FIELD UDINT 16#70D ERR_CERT_ERROR_IN_CRL_LAST_UPDATE_FIELD UDINT 16#70E ERR_CERT_ERROR_IN_CRL_NEXT_UPDATE_FIELD UDINT 16#70F ERR_CERT_OUT_OF_MEM UDINT 16#710 ERR_CERT_DEPTH_ZERO_SELF_SIGNED_CERT UDINT 16#711 ERR_CERT_SELF_SIGNED_CERT_IN_CHAIN UDINT 16#712 ERR_CERT_UNABLE_TO_GET_ISSUER_CERT_LOCALLY UDINT 16#713 ERR_CERT_UNABLE_TO_VERIFY_LEAF_SIGNATURE UDINT 16#714 ERR_CERT_CHAIN_TOO_LONG UDINT 16#715 ERR_CERT_REVOKED UDINT 16#716 ERR_CERT_INVALID_CA UDINT 16#717 ERR_CERT_PATH_LENGTH_EXCEEDED UDINT 16#718 ERR_CERT_INVALID_PURPOSE UDINT 16#719 ERR_CERT_UNTRUSTED UDINT 16#71A ERR_CERT_REJECTED UDINT 16#71B ERR_CERT_SUBJECT_ISSUER_MISMATCH UDINT 16#71C These are ‘informational’ when looking for issuer cert ERR_CERT_AKID_SKID_MISMATCH UDINT 16#71D ERR_CERT_AKID_ISSUER_SERIAL_MISMATCH UDINT 16#71E ERR_CERT_KEYUSAGE_NO_CERTSIGN UDINT 16#71F ERR_CERT_UNABLE_TO_GET_CRL_ISSUER UDINT 16#720 ERR_CERT_UNHANDLED_CRITICAL_EXTENSION UDINT 16#721 ERR_CERT_KEYUSAGE_NO_CRL_SIGN UDINT 16#722 ERR_CERT_UNHANDLED_CRITICAL_CRL_EXTENSION UDINT 16#723 ERR_CERT_INVALID_NON_CA UDINT 16#724 ERR_CERT_PROXY_PATH_LENGTH_EXCEEDED UDINT 16#725 ERR_CERT_KEYUSAGE_NO_DIGITAL_SIGNATURE UDINT 16#726 ERR_CERT_PROXY_CERTIFICATES_NOT_ALLOWED UDINT 16#727 ERR_CERT_INVALID_EXTENSION UDINT 16#728 ERR_CERT_INVALID_POLICY_EXTENSION UDINT 16#729 ERR_CERT_NO_EXPLICIT_POLICY UDINT 16#72A ERR_CERT_DIFFERENT_CRL_SCOPE UDINT 16#72B ERR_CERT_UNSUPPORTED_EXTENSION_FEATURE UDINT 16#72C ERR_CERT_UNNESTED_RESOURCE UDINT 16#72D ERR_CERT_PERMITTED_VIOLATION UDINT 16#72E ERR_CERT_EXCLUDED_VIOLATION UDINT 16#72F ERR_CERT_SUBTREE_MINMAX UDINT 16#730 ERR_CERT_UNSUPPORTED_CONSTRAINT_TYPE UDINT 16#731 ERR_CERT_UNSUPPORTED_CONSTRAINT_SYNTAX UDINT 16#732 ERR_CERT_UNSUPPORTED_NAME_SYNTAX UDINT 16#733 ERR_CERT_CRL_PATH_VALIDATION_ERROR UDINT 16#734 ERR_CERT_APPLICATION_VERIFICATION UDINT 16#735 The application is not happy ERR_CERT_MISSING UDINT 16#736 ERR_CERT_UNKNOWN_ERROR UDINT 16#737 ERR_CERT_UNABLE_TO_GET_ISSUER_CRL UDINT 16#738 ERR_REDU_TOO_TAGS UDINT 16#B00 Visu redundancy errors ERR_REDU_MEMORY UDINT 16#B01 ERR_REDU_CLIENT_CREATION_ERR UDINT 16#B02
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
CmpEventMgr Implementation Library Documentation ¶ Company System Title CmpEventMgr Implementation Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpEventMgr Implementation Description 1 ¶ This library provides access to the event manager of the runtime system. The event manager handles events from components (provider) and transmits these events via callbacks to IEC consumers (functions or function-blocks). Contents: ¶ EventClose2 (Function) EventCreate (Function) EventCreate2 (Function) EventCreateEventID (Function) EventDelete2 (Function) EventGetClass (Function) EventGetEvent (Function) EventOpen (Function) EventPost (Function) EventPost2 (Function) EventPostByEvent (Function) EventPostByEvent2 (Function) EventRegisterCallback (Function) EventRegisterCallback2 (Function) EventRegisterCallbackFunction (Function) EventRegisterCallbackFunction2 (Function) EventRegisteredCallbacks (Function) EventUnregisterCallback (Function) EventUnregisterCallbackFunction (Function) EventUnregisterCallbackFunction2 (Function) Indices and tables ¶ 1 Based on CmpEventMgr Implementation.library, last modified 20.04.2021, 15:40:14. LibDoc 4.4.0.0-b.27 The content file CmpEventMgr Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:40:15.
EventClose2 (FUN) ¶ FUNCTION EventClose2 : RTS_IEC_RESULT Close an event specified by handle InOut: Scope Name Type Comment Return EventClose2 RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Event handle
EventCreate (FUN) ¶ FUNCTION EventCreate : RTS_IEC_HANDLE Creates a new event object. If event still exists, a handle to this object will be returned. An IEC event is typically created by the provider in FB_Init of a function block InOut: Scope Name Type Comment Return EventCreate RTS_IEC_HANDLE Input EventId UDINT Event ID of the event. Contains the class and the event CmpIdProvider UDINT Component ID of the provider Inout Result RTS_IEC_RESULT Error code
