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
AppCallGetProperty2 (FUN) ¶ FUNCTION AppCallGetProperty2 : RTS_IEC_RESULT InOut: Scope Name Type Return AppCallGetProperty2 RTS_IEC_RESULT Input pInstance POINTER TO BYTE ppGetMethod POINTER TO POINTER TO BYTE ppbyValue POINTER TO POINTER TO BYTE ulSize __XWORD
AppCallGetProperty2Release (FUN) ¶ FUNCTION AppCallGetProperty2Release : RTS_IEC_RESULT InOut: Scope Name Type Return AppCallGetProperty2Release RTS_IEC_RESULT Input pbyValue POINTER TO BYTE
AppCallGetProperty3 (FUN) ¶ FUNCTION AppCallGetProperty3 : RTS_IEC_RESULT InOut: Scope Name Type Return AppCallGetProperty3 RTS_IEC_RESULT Input pInstance POINTER TO BYTE ppGetMethod POINTER TO POINTER TO BYTE ppbyValue POINTER TO POINTER TO BYTE ulSize __XWORD ulOffset __XWORD