IDatasourcesMgr2.RemoveNotificationClient (METH) ¶ METHOD RemoveNotificationClient : SysTypes.RTS_IEC_RESULT This method can be called to remove an object that was formerly registered using IDatasourcesMgr2.AddNotificationClient InOut: Scope Name Type Comment Return RemoveNotificationClient SysTypes.RTS_IEC_RESULT An error code that signals whether the removal was successful. Input client INotificationClient The notification client object to remove
IDatasourcesMgr2.Unlock (METH) ¶ METHOD Unlock : SysTypes.RTS_IEC_RESULT Releases a previously taken lock by IDatasourcesMgr2.Lock InOut: Scope Name Type Comment Return Unlock SysTypes.RTS_IEC_RESULT Returns a runtime system error code (see CmpErrors.library) or one of Errors
IDatasourcesMgr3 (ITF) ¶ INTERFACE IDatasourcesMgr3 EXTENDS IDatasourcesMgr2 Extension of IDatasourcesMgr2 supporting expanding of non scalar variables Properties: PersistantItemListCount , inherited from IDatasourcesMgr2 Methods: UseDataExpanding ActionRecordDelete , inherited from IDatasourcesMgr ActionRecordReplay , inherited from IDatasourcesMgr ActionRecordingGetResult , inherited from IDatasourcesMgr ActionRecordingStart , inherited from IDatasourcesMgr AddNotificationClient , inherited from IDatasourcesMgr2 AllItemsOk , inherited from IDatasourcesMgr BeginDataConfiguration , inherited from IDatasourcesMgr CreateItemList , inherited from IDatasourcesMgr CreatePersistantItemList , inherited from IDatasourcesMgr2 DeleteItemList , inherited from IDatasourcesMgr DeletePersistantItemList , inherited from IDatasourcesMgr2 EndDataConfiguration , inherited from IDatasourcesMgr GetDatasource , inherited from IDatasourcesMgr GetItemInfo , inherited from IDatasourcesMgr GetPersistantItemList , inherited from IDatasourcesMgr2 Lock , inherited from IDatasourcesMgr2 ReadItemsSync , inherited from IDatasourcesMgr ReleaseData , inherited from IDatasourcesMgr RemoveNotificationClient , inherited from IDatasourcesMgr2 SetCredentialsProvider , inherited from IDatasourcesMgr Unlock , inherited from IDatasourcesMgr2 UseData , inherited from IDatasourcesMgr WriteItemsSync , inherited from IDatasourcesMgr Structure: UseDataExpanding (Method)
IDatasourcesMgr3.UseDataExpanding (METH) ¶ METHOD UseDataExpanding : SysTypes.RTS_IEC_RESULT Activates the item of the given instance path for monitoring similar to IDatasourcesMgr.UseData . The difference of this method to IDatasourcesMgr.UseData is that variables of non scalar datatypes (eg. structures or arrays) maybe expanded automatically so that all sub elements are monitored instead of the complete value if that is necessary for a specific type of connected datasource. Note The items are reference counted so each call to IDatasourcesMgr.UseData or IDatasourcesMgr3.UseDataExpanding requires a matching call to IDatasourcesMgr.ReleaseData InOut: Scope Name Type Comment Return UseDataExpanding SysTypes.RTS_IEC_RESULT Returns a runtime system error code (see CmpErrors.library) or one of Errors Input pstSymbol POINTER TO STRING The symbolic name of the variable to activate. Here the name of the variable on the local PLC/HMI is expected.
IDatasourcesMgr4 (ITF) ¶ INTERFACE IDatasourcesMgr4 EXTENDS IDatasourcesMgr3 Extension of IDatasourcesMgr3 supporting the datasources browsing Properties: CountDatasources PersistantItemListCount , inherited from IDatasourcesMgr2 Methods: GetDatasourceItfByIndex ActionRecordDelete , inherited from IDatasourcesMgr ActionRecordReplay , inherited from IDatasourcesMgr ActionRecordingGetResult , inherited from IDatasourcesMgr ActionRecordingStart , inherited from IDatasourcesMgr AddNotificationClient , inherited from IDatasourcesMgr2 AllItemsOk , inherited from IDatasourcesMgr BeginDataConfiguration , inherited from IDatasourcesMgr CreateItemList , inherited from IDatasourcesMgr CreatePersistantItemList , inherited from IDatasourcesMgr2 DeleteItemList , inherited from IDatasourcesMgr DeletePersistantItemList , inherited from IDatasourcesMgr2 EndDataConfiguration , inherited from IDatasourcesMgr GetDatasource , inherited from IDatasourcesMgr GetItemInfo , inherited from IDatasourcesMgr GetPersistantItemList , inherited from IDatasourcesMgr2 Lock , inherited from IDatasourcesMgr2 ReadItemsSync , inherited from IDatasourcesMgr ReleaseData , inherited from IDatasourcesMgr RemoveNotificationClient , inherited from IDatasourcesMgr2 SetCredentialsProvider , inherited from IDatasourcesMgr Unlock , inherited from IDatasourcesMgr2 UseData , inherited from IDatasourcesMgr UseDataExpanding , inherited from IDatasourcesMgr3 WriteItemsSync , inherited from IDatasourcesMgr Structure: CountDatasources (Property) GetDatasourceItfByIndex (Method)
IDatasourcesMgr4.CountDatasources (PROP) ¶ PROPERTY CountDatasources : INT
IDatasourcesMgr4.GetDatasourceItfByIndex (METH) ¶ METHOD GetDatasourceItfByIndex : IDatasource3 Gets datasource interface by index InOut: Scope Name Type Return GetDatasourceItfByIndex IDatasource3 Input index INT
INotificationClient (ITF) ¶ INTERFACE INotificationClient EXTENDS __SYSTEM.IQueryInterface This interface can be implemented and registered using IDatasourcesMgr2.AddNotificationClient to get notified about operations on variables executed by the datasources. Methods: ListOperationDone ListOperationStart ListValueRead ListValueWrite ReadRequestDone ReadRequestStart SingleValueRead SingleValueWrite WriteRequestDone WriteRequestStart Structure: ListOperationDone (Method) ListOperationStart (Method) ListValueRead (Method) ListValueWrite (Method) ReadRequestDone (Method) ReadRequestStart (Method) SingleValueRead (Method) SingleValueWrite (Method) WriteRequestDone (Method) WriteRequestStart (Method)
ItemQuality (ENUM) ¶ TYPE ItemQuality : This enumeration represents the quality of a IDataItemBase Attributes: qualified_only InOut: Name Comment New The item was not yet monitored. The quality will be assigned when this happened the first time Good The item is in good state and it has been monitored at least once Bad The item could not be monitored correctly. For details have a look at the according error code.
MonitoringState (ENUM) ¶ TYPE MonitoringState : Is used to monitor the state of a data source for the data source editor or in an IEC application Attributes: qualified_only InOut: Name Comment Initialized Left after a call to StartConnect Connecting Switches to Connected after succeeded Connecting and to WaitingForReconnect after errors Connected The datasource is connected ShuttingDown Left to Shutdown after succeeded call to ShuttingDown Shutdown Terminal state WaitingForReconnect Left after some time in favor of Initialized WaitingForCommSetting Waiting that dynamic configuration setting has been ready Unknown
