EVTPARAM_CmpAppReset (STRUCT) ¶ TYPE EVTPARAM_CmpAppReset : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”ewResetOption” type=”IN”>Reset option</element> InOut: Name Type pApp POINTER TO APPLICATION ewResetOption RESET_OPTION
EVTPARAM_CmpAppResetAllApplications (STRUCT) ¶ TYPE EVTPARAM_CmpAppResetAllApplications : STRUCT <category>Event parameter</category> <element name=”ewResetOption” type=”IN”>Reset option</element> InOut: Name Type ewResetOption RESET_OPTION
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CAA Ressource Manager Extern ¶ Library Identification ¶ Placeholder: CAA ResMan Default Resolution: CAA Ressource Manager Extern, * (CAA Technical Workgroup) Namespace: RSM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA ResMan CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpBACnet ¶ Library Identification ¶ Placeholder: CmpBACnet Default Resolution: CmpBACnet, * (3S - Smart Software Solutions GmbH) Namespace: CmpBACnet Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CmpBACnet CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog CmpSettings ¶ Library Identification ¶ Placeholder: CmpSettings Default Resolution: CmpSettings, * (System) Namespace: CmpSettings Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSettings Common Behaviour Model ¶ Library Identification ¶ Placeholder: CBML Default Resolution: Common Behaviour Model, * (3S - Smart Software Solutions GmbH) Namespace: CBML Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CBML Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager IoDrvEthernet Interfaces ¶ Library Identification ¶ Name: IoDrvEthernet Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IIoDrvEthernet Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDrvEthernet Interfaces, * (3S - Smart Software Solutions GmbH) IoDrvUtility ¶ Library Identification ¶ Placeholder: IoDriver Utility Default Resolution: IoDrvUtility, * (3S - Smart Software Solutions GmbH) Namespace: IoDrvUtility Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDriver Utility IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSem ¶ Library Identification ¶ Placeholder: SysSem Default Resolution: SysSem, * (System) Namespace: SysSem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSem SysTimeCore ¶ Library Identification ¶ Placeholder: SysTimeCore Default Resolution: SysTimeCore, * (System) Namespace: SysTimeCore Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTimeCore 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) Util ¶ Library Identification ¶ Placeholder: Util Default Resolution: Util, * (System) Namespace: Util Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Util Library Parameter ¶ Parameter: IBLOCKSIZE = 22800
EVTPARAM_CmpAppRetainBackupState (STRUCT) ¶ TYPE EVTPARAM_CmpAppRetainBackupState : STRUCT <category>Event parameter</category> <element name=”pszBootprojectName” type=”IN”>Name of boot project</element> <element name=”uiBackupState” type=”IN”>State of retain backup (see category “Retain backup state”</element> InOut: Name Type pszBootprojectName POINTER TO STRING uiBackupState UINT
CmpApp Library Documentation ¶ Company System Title CmpApp Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpApp Description 1 ¶ This library provides access to the application manager of the runtime system. Access to all running applications and the usage of all events of the application manager is possible. Contents: ¶ APPLICATION (Struct) APPLICATION_INFO (Struct) APP_MEMORY_SEGMENT (Struct) AppCallGetProperty (Function) AppCallGetProperty2 (Function) AppCallGetProperty2Release (Function) AppCallGetProperty3 (Function) AppCallSetProperty (Function) AppCallSetProperty2 (Function) AppFindApplicationByName (Function) AppGenerateException (Function) AppGetApplicationByAreaAddress (Function) AppGetApplicationFlags (Function) AppGetApplicationInfo (Function) AppGetAreaAddress (Function) AppGetAreaOffsetByAddress (Function) AppGetAreaPointer (Function) AppGetAreaSize (Function) AppGetCurrent (Function) AppGetFirstApp (Function) AppGetNextApp (Function) AppGetProjectInformation (Function) AppGetSegment (Function) AppGetSegmentAddress (Function) AppGetSegmentSize (Function) AppNumOfActiveSessions (Function) AppRegisterPropAccessFunctions (Function) AppReset (Function) AppRestoreRetainsFromFile (Function) AppStartApplication (Function) AppStopApplication (Function) AppStoreRetainsInFile (Function) ApplicationFlags (GVL) ApplicationState (GVL) AreaTypes (GVL) EventIDs (GVL) EventParameter EVTPARAM_CmpApp (Struct) EVTPARAM_CmpAppAllBootAppsLoaded (Struct) EVTPARAM_CmpAppComm (Struct) EVTPARAM_CmpAppCommCycle (Struct) EVTPARAM_CmpAppConfig (Struct) EVTPARAM_CmpAppDeny (Struct) EVTPARAM_CmpAppDenyDelete (Struct) EVTPARAM_CmpAppDenyLoadBootproject (Struct) EVTPARAM_CmpAppDenyStart (Struct) EVTPARAM_CmpAppDenyStop (Struct) EVTPARAM_CmpAppException (Struct) EVTPARAM_CmpAppExit (Struct) EVTPARAM_CmpAppOEMServiceTag (Struct) EVTPARAM_CmpAppOperatingStateChanged (Struct) EVTPARAM_CmpAppPrepareLoadBootproject (Struct) EVTPARAM_CmpAppRegisterBootproject (Struct) EVTPARAM_CmpAppReset (Struct) EVTPARAM_CmpAppResetAllApplications (Struct) EVTPARAM_CmpAppRetainBackupState (Struct) EVTPARAM_CmpAppSourceDownload (Struct) EVTPARAM_CmpAppStateChanged (Struct) EVTPARAM_CmpAppStop (Struct) Exception (GVL) GlobalConstants (GVL) MAKE_EVENTID (Function) OperatingState (GVL) OperationReason (GVL) Operations (GVL) PROJECT_INFO (Struct) RESET_OPTION (Enum) RetainBackupState (GVL) Indices and tables ¶ 1 Based on CmpApp.library, last modified 20.04.2021, 15:33:22. LibDoc 4.4.0.0-b.27 The content file CmpApp.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:33:22.
APPLICATION (STRUCT) ¶ TYPE APPLICATION : STRUCT InOut: Name Type Comment pAppParent POINTER TO APPLICATION POINTER TO parent application iId UDINT Id of the application. Is always unique. CodeGuid ARRAY [0..15] OF BYTE GUID for IEC code DataGuid ARRAY [0..15] OF BYTE GUID for IEC data udiState UDINT State of the application. See definitions Application states udiOpState UDINT Operating state of the application. See definitions Application operation states hBootproject RTS_IEC_HANDLE Handle to bootproject hDebugTask RTS_IEC_HANDLE Handle to debug task pfGlobalInit POINTER TO BYTE Global Init Function pfGlobalExit POINTER TO BYTE Global Exit Function hSessionIdPool RTS_IEC_HANDLE Handle a pool of session-ids hForcePool RTS_IEC_HANDLE Handle a pool of force entries hBPPool RTS_IEC_HANDLE Handle a pool of breakpoints bPersistentForce DINT Is persistent force enabled szName STRING(MAX_LEN_APPLNAME) Application name udiPSVersion UDINT Version number of Programming system (set in download) udiTargetSettingVersion UDINT Version number of Target settings used by PS (set in download)
IEC_BACNET_ERROR_TO_STRING (FUN) ¶ FUNCTION IEC_BACNET_ERROR_TO_STRING : STRING InOut: Scope Name Type Return IEC_BACNET_ERROR_TO_STRING STRING Input bacnetError CmpBACnet.IEC_BACNET_ERROR
APPLICATION_INFO (STRUCT) ¶ TYPE APPLICATION_INFO : STRUCT <category>Application information</category> <description> Contains the application information as specified in the application property dialog in CoDeSys. </description> <element name=”pstProjectName” type=”OUT”>Pointer project name</element> <element name=”pstAuthor” type=”OUT”>Pointer to author</element> <element name=”pstVersion” type=”OUT”>Pointer to version as string in the format “x.x.x.x”</element> <element name=”pstDescription” type=”OUT”>Pointer to description</element> <element name=”pstProfile” type=”OUT”>Pointer to used CoDeSys profile name</element> <element name=”dtLastChanges” type=”OUT”>Time and date of last modification of the application (UTC)</element> InOut: Name Type pstProjectName POINTER TO STRING(255) pstAuthor POINTER TO STRING(255) pstVersion POINTER TO STRING(255) pstDescription POINTER TO STRING(255) pstProfile POINTER TO STRING(255) dtLastChanges DT
APP_MEMORY_SEGMENT (STRUCT) ¶ TYPE APP_MEMORY_SEGMENT : STRUCT <category>Application memory segment</category> <description> Describes a memory segment of an application. </description> <element name=”wType” type=”IN”>Type of the segment. See category “Area Types” in SysMemItf.h.</element> <element name=”wArea” type=”IN”>Area in which the segment is residing</element> <element name=”dwOffset” wType=”IN”>Offset in the area, in which the segment is residing</element> <element name=”dwSize” wType=”IN”>Size of the segment in bytes</element> <element name=”dwHighestUsedAddress” wType=”IN”>Highest used address in the segment (has no significance for input, output, memory)</element> InOut: Name Type wType WORD wArea WORD dwOffset DWORD dwSize DWORD dwHighestUsedAddress DWORD
AppCallGetProperty (FUN) ¶ FUNCTION AppCallGetProperty : RTS_IEC_RESULT InOut: Scope Name Type Return AppCallGetProperty RTS_IEC_RESULT Input pInstance POINTER TO BYTE ppGetMethod POINTER TO POINTER TO BYTE pbyValue POINTER TO BYTE ulSize __XWORD