AppGetSegment (FUN) ¶ FUNCTION AppGetSegment : POINTER TO APP_MEMORY_SEGMENT InOut: Scope Name Type Return AppGetSegment POINTER TO APP_MEMORY_SEGMENT Input pApp POINTER TO APPLICATION uiType UINT pResult POINTER TO RTS_IEC_RESULT
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.
EVTPARAM_CmpAppException (STRUCT) ¶ TYPE EVTPARAM_CmpAppException : STRUCT InOut: Name Type pApp POINTER TO APPLICATION hIecTask RTS_IEC_HANDLE udiException UDINT
EVTPARAM_CmpAppExit (STRUCT) ¶ TYPE EVTPARAM_CmpAppExit : STRUCT <category>Event parameter</category> <element name=”pApp” type=”IN”>Pointer to application description</element> <element name=”ulExitReason” type=”IN”>Exit reason. See category “OperationReason” for details</element> InOut: Name Type pApp POINTER TO APPLICATION ulExitReason UDINT
IOPCUAClientMethodCallback (ITF) ¶ INTERFACE IOPCUAClientMethodCallback EXTENDS __SYSTEM.IQueryInterface These callbacks are used to send the results of method calls back to the caller. Methods: CallCallback Structure: CallCallback (Method)
IOPCUAClientMethodCallback.CallCallback (METH) ¶ METHOD CallCallback : OpcUa_StatusCode Called in response to OpcUaClient_Call InOut: Scope Name Type Comment Return CallCallback OpcUa_StatusCode Input hConnection RTS_IEC_HANDLE The handle of the connection used to call read. serviceResult OpcUa_StatusCode The result of the read service. numOfMethods OpcUa_Int32 The number of requested method calls and results pMethodCalls POINTER TO OpcUa_CallMethodRequest The called methods. :note: This pointer is independent from the pointer passed to OPCUAClient_Call. Do not free up any memory here. pMethodResults POINTER TO OpcUa_CallMethodResult The results of the method. Do not free this memory.
IOPCUAClientMonitoredItemCallback (ITF) ¶ INTERFACE IOPCUAClientMonitoredItemCallback EXTENDS __SYSTEM.IQueryInterface This callback interface is used to report changes to monitored items to the client. Methods: ItemEventCallback ItemParameterCallback ItemStateCallback ItemValueCallback Structure: ItemEventCallback (Method) ItemParameterCallback (Method) ItemStateCallback (Method) ItemValueCallback (Method)
IOPCUAClientMonitoredItemCallback.ItemEventCallback (METH) ¶ METHOD ItemEventCallback : OpcUa_StatusCode This callback is used to send event notifications to the client. This will only be called for monitored items that register to an event notifier. InOut: Scope Name Type Comment Return ItemEventCallback OpcUa_StatusCode Input hMonitoredItem RTS_IEC_HANDLE Handle to the event monitored item. noOfEventFields OpcUa_Int32 Number of fields available on the event fields paramter. eventFields POINTER TO OpcUa_Variant Pointer to a list of event fields. The fields have the same order as the registered event fields. reason OpcUa_StatusCode Status code of the operation.
IOPCUAClientMonitoredItemCallback.ItemParameterCallback (METH) ¶ METHOD ItemParameterCallback : OpcUa_StatusCode The callback is called when the parameters of a monitored item (both event and sampling) has changed. This happens typically after creation (OpcUaClient_CreateMonitoredItem) or modification (OpcUaClient_ModifyMonitoredItems) of a monitored item. The values in this call represent the reviced parameters from the server. InOut: Scope Name Type Comment Return ItemParameterCallback OpcUa_StatusCode Input hMonitoredItem RTS_IEC_HANDLE Handle to the moniotred item. monitoringMode OpcUa_MonitoringMode The new monitoring mode samplingInterval OpcUa_Double The reviced sampling interval for sampling items. queueSize OpcUa_UInt32 The reviced queue size. filter OpcUa_ExtensionObject The reviced filters. reason OpcUa_StatusCode Status code if the operation was successful.
IOPCUAClientMonitoredItemCallback.ItemStateCallback (METH) ¶ METHOD ItemStateCallback : OpcUa_StatusCode This callback is called to inform the client on state changes InOut: Scope Name Type Comment Return ItemStateCallback OpcUa_StatusCode Input hMonitoredItem RTS_IEC_HANDLE Handle to the moniotred item. newState OPCUAClientMonitoredItemState The new state of the monitored item. reason OpcUa_StatusCode The reason for the state transition.
