File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:56:50 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTls.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTls.clean.json version version 2.0.0.0 ProjectInformation ActivateSigning bool False IsCommonLibraryContainer True Released True LastModificationDateTime date 20.04.2021, 15:56:50 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 CmpTls Project CmpTls Title CmpTls Version version 3.5.17.0
CmpTls Interfaces Library Documentation ¶ Company System Title CmpTls Interfaces Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This interface contains common types an error codes related to the CmpTls Implementation library. Contents: ¶ CmpTlsConstants (GVL) CmpTlsMethod (Enum) ERRORS (GVL) IVerifyCertCallback (Interface) VerifyCertCallback (Method) Indices and tables ¶ 1 Based on CmpTls_Itfs.library, last modified 20.04.2021, 15:57:27. LibDoc 4.4.0.0-b.27 The content file CmpTls_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:57:27.
CmpTlsConstants (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant TLS_VERIFY_NONE DWORD 16#1 Don’t perform a peer verification (Default for server) TLS_VERIFY_PEER DWORD 16#2 Perform a peer verification (Default for client). For Server: Send a client certificate request. If a client certificate is available verify this certificate. TLS_VERIFY_FAIL_IF_NO_PEER_CERT DWORD 16#4 Only for for Server methods. Forces the connection to be terminated if the client does not provide a certificate. Add this to TLS_VERIFY_PERR TLS_VERIFY_CLIENT_ONCE DWORD 16#8 Only for for Server methods. Request the client certificate only whithin the initial handshake. While renegortiation no certificate is requested from the client. Add this to TLS_VERIFY_PERR
CmpTlsMethod (ENUM) ¶ TYPE CmpTlsMethod : Attributes: qualified_only InOut: Name Initial Comment SSLv2_CLIENT 16#0 Not Available SSLv3_CLIENT 16#1 SSL v3 Client SSLv23_CLIENT 16#2 SSL Client accepting all versions but SSL v2 TLSv1_CLIENT 16#3 TLS 1.1 Client TLSv2_CLIENT 16#4 TLS 1.2 Client (Default for CmpTlsCreateContext) SSLv2_SERVER 16#5 Not Available SSLv3_SERVER 16#6 SSL v3 Server SSLv23_SERVER 16#7 SSL Server accepting all versions but SSL v2 TLSv1_SERVER 16#8 TLS 1.1 Server TLSv2_SERVER 16#9 TLS 1.2 Server TLSv3_CLIENT 16#A TLS 1.3 Client TLSv3_SERVER 16#B TLS 1.3 Server
ERRORS (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant ERR_TLS_INTERNAL DWORD 16#600 INTERNAL Error OF TLS component ERR_TLS_CONNECTION_CLOSED DWORD 16#610 The TLS connection has been closed. ERR_TLS_RETRY_OPERATION DWORD 16#611 The same TLS IO operation should be called again ERR_TLS_IO_SYSTEM DWORD 16#612 The underlaying transport caused a problem ERR_TLS_WANT_READ DWORD 16#613 The finish THIS operation data have TO be read. The data was NOT available. Receive TLS protocol data TO finish THIS operation ERR_TLS_WANT_WRITE DWORD 16#614 TO finish THIS operation data has TO be written. The buffer doesn’t allow that. Send existing data to allow writing new data
IVerifyCertCallback (ITF) ¶ INTERFACE IVerifyCertCallback EXTENDS __SYSTEM.IQueryInterface Methods: VerifyCertCallback Structure: VerifyCertCallback (Method)
IVerifyCertCallback.VerifyCertCallback (METH) ¶ METHOD VerifyCertCallback : RTS_IEC_RESULT This function is called to allow futher checks on the peers certificate. Return ERR_CERT_OK if the certificate is trustworthy. If not return any (expect ERR_CERT_OK) of the error codes found at CmpX509Cert.ERRORS InOut: Scope Name Type Comment Return VerifyCertCallback RTS_IEC_RESULT Input hCert RTS_IEC_HANDLE Handle to the peers certificate. Can be passed to all functions provieded by CmpX509Cert library. verifyResult RTS_IEC_RESULT Result of the pre verification. See CmpX509Cert.ERRORS for details of the corresponding error codes.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:57:27 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpTls_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpTls_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:57:27 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpTls_Itfs Title CmpTls Interfaces Version version 3.5.17.0
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)
CmpTraceMgr Library Documentation ¶ Company System Title CmpTraceMgr Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpTraceMgr Description 1 ¶ This library provides access to the runtime system component CmpTraceMgr. The trace manager handles trace packets, that are defined from: the Trace editor in CoDeSys, a runtime system component, or an IEC program. A trace packet is the container for trace variables, which are called records. A trace packet is is always identified by its name, which must be unique. A trace record contains the trace of a single variable, including the buffer used to store the time-stamped samples. This is a typical sequence of function calls a client of CmpTraceMgr will use: TraceMgrPacketCreate TraceMgrRecordAdd TraceMgrPacketComplete TraceMgrPacketStart TraceMgrPacketStop TraceMgrPacketRestart / TraceMgrPacketStart / TraceMgrPacketDelete Contents: ¶ ComponentId (GVL) EventParameter EVTPARAM_CmpTraceMgr_Packet (Struct) EVTPARAM_CmpTraceMgr_Record (Struct) EventIDs (GVL) GlobalConstants (GVL) Structs AddressArea (Struct) Monitoring2ByteCode (Struct) Monitoring2ByteCodeUnion (Union) MonitoringService (Struct) PropertyLocation (Struct) SymVarAccess (Struct) SystemParameter (Struct) TraceAddress (Union) TracePacketConfiguration (Struct) TraceRecordConfiguration (Struct) TraceRecordEntry (Struct) TraceState (Struct) TraceTrigger (Struct) TraceVarInfo (Union) TraceVariable (Struct) TraceVariableAddress (Struct) TriggerState (Struct) TriggerValue (Union) TypeClass3 (Alias) TRACE_PACKET_FLAGS (GVL) TRACE_PACKET_STATE (GVL) TRACE_RECORD_GRAPH_TYPES (GVL) TRACE_TRIGGER_EDGE (GVL) TRACE_TRIGGER_FLAGS (GVL) TRACE_TRIGGER_STATE (GVL) TRACE_VAR_ADDRESS_FLAGS (GVL) TraceMgrGetConfigFromFile (Function) TraceMgrGetConfigFromFileRelease (Function) TraceMgrPacketCheckTrigger (Function) TraceMgrPacketClose (Function) TraceMgrPacketComplete (Function) TraceMgrPacketCreate (Function) TraceMgrPacketDelete (Function) TraceMgrPacketDisable (Function) TraceMgrPacketDisableTrigger (Function) TraceMgrPacketEnable (Function) TraceMgrPacketEnableTrigger (Function) TraceMgrPacketGetAbsoluteStartTime (Function) TraceMgrPacketGetChangeTimestamp (Function) TraceMgrPacketGetConfig (Function) TraceMgrPacketGetFirst (Function) TraceMgrPacketGetNext (Function) TraceMgrPacketGetStartTime (Function) TraceMgrPacketGetState (Function) TraceMgrPacketOpen (Function) TraceMgrPacketReadBegin (Function) TraceMgrPacketReadEnd (Function) TraceMgrPacketReadFirst (Function) TraceMgrPacketReadFirst2 (Function) TraceMgrPacketReadNext (Function) TraceMgrPacketReadNext2 (Function) TraceMgrPacketResetTrigger (Function) TraceMgrPacketRestart (Function) TraceMgrPacketRestore (Function) TraceMgrPacketStart (Function) TraceMgrPacketStop (Function) TraceMgrPacketStore (Function) TraceMgrRecordAdd (Function) TraceMgrRecordGetConfig (Function) TraceMgrRecordGetFirst (Function) TraceMgrRecordGetNext (Function) TraceMgrRecordRemove (Function) TraceMgrRecordUpdate (Function) TraceMgrRecordUpdate2 (Function) TraceMgrRecordUpdate3 (Function) TraceMgrRecordUpdate4 (Function) TraceMgrRecordUpdate5 (Function) Indices and tables ¶ 1 Based on CmpTraceMgr.library, last modified 20.04.2021, 15:57:46. LibDoc 4.4.0.0-b.27 The content file CmpTraceMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:57:46.
