PlcShellSetEof (FUN) ¶ FUNCTION PlcShellSetEof : RTS_IEC_RESULT Set EOF This function should be called when the Command Handler is finished with it’s output. RETURN: Returns the runtime system error code (see CmpErrors.library) InOut: Scope Name Type Return PlcShellSetEof RTS_IEC_RESULT
PlcShellSkip (FUN) ¶ FUNCTION PlcShellSkip : RTS_IEC_RESULT Skip a number of blocks in the output. If a Command Handler sends a huge amount of output, it might be necessary, that this output is splitted into several blocks by the communication layer. When this happens, the communication layer will discard everything, but the current block from the output and recall the Command Handler several times. To avoid this, an intelligent Command Handler can generate only the currently necessary block of output. For this, it needs to “skip” all blocks, which are already sent, by calling this function. Then it should write only that much data, that they fit into one block and call PlcShellSetEof() when it is finished. RETURN: Returns the runtime system error code (see CmpErrors.library) InOut: Scope Name Type Return PlcShellSkip RTS_IEC_RESULT Input iBlockID DINT
PlcShellUnregister (FUN) ¶ FUNCTION PlcShellUnregister : RTS_IEC_RESULT Unregister a new Command Handler Unregister the command handler, which is passed to this function. Most likely this function will be used in FB_exit, because every Command Handler in IEC has to unregister when the application is deleted. RETURN: Returns the runtime system error code (see CmpErrors.library) InOut: Scope Name Type Return PlcShellUnregister RTS_IEC_RESULT Input pICallback ICmpEventCallback
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:54:06 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpPlcShell.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpPlcShell.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 15:54:06 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace SHELL Description See: Description Placeholder CmpPlcShell Project CmpPlcShell Title CmpPlcShell Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr 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)
VariableValue (STRUCT) ¶ TYPE VariableValue : STRUCT Instances of this structure represent the value and status information for a single variable Note In fact this structure is the same than PlcVarValue from the PLCHandler SDK InOut: Name Type Comment ulTimeStamp UDINT UTC-Timestamp of the value, is read from the PLC Note The UTC-timestamp is not supported by all PLCs quality BYTE Quality of the value 1: Value was read from the PLC 0: Value was not read from the PLC data ARRAY [0..0] OF BYTE Array with the value. The concrete size of this array depends on the data type (byData[1] is only a placeholder with the minimum size). Should only be accessed, if bQuality is TRUE
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 01.04.2022, 08:14:28 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpPLCHandlerDataModelDefault.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpPLCHandlerDataModelDefault.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True LastModificationDateTime date 01.04.2022, 08:14:28 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company CODESYS GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace PLCH Description See: Description DocFormat reStructuredText Placeholder CmpPLCHandlerDataModelDefault Project CmpPLCHandlerDataModelDefault Title CmpPLCHandlerDataModelDefault Version version 3.5.18.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces.
CmpPLCHandlerDataModelLP64 Library Documentation ¶ Company CODESYS GmbH Title CmpPLCHandlerDataModelLP64 Version 3.5.18.0 Categories System|SysLibs Namespace PLCH Author CODESYS Development GmbH Placeholder CmpPLCHandlerDataModelLP64 Description 1 ¶ Library that allows access to the symbolic monitoring functionality of the PLCHandler. This is an additional library needed by CmpPLCHandler.library in order to handle data access on all 64bit platforms except Windows (LP64 data model). Contents: ¶ CmpPLCHandler Structs Indices and tables ¶ 1 Based on CmpPLCHandlerDataModelLP64.library, last modified 01.04.2022, 08:14:43. LibDoc 4.4.0.0-b.27 The content file CmpPLCHandlerDataModelLP64.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 01.04.2022, 08:14:43.
CmpPLCHandler ¶ Structs VariableValue (Struct)
