Datasources Interfaces Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title Datasources Interfaces Version 4.3.0.0 Categories Intern|DataSources Namespace IDatasources Author 3S - Smart Software Solutions GmbH Description 1 ¶ A interface library publishing the interfaces of the datasources feature both for application use as well as for driver implementation. Contents: ¶ ByteOrder (Enum) Credentials ICredentials (Interface) ICredentialsProvider (Interface) ICredentialsUserPassword (Interface) Drivers relevant only IDataItem (Interface) IDataItemValueAssigner (Interface) IDriver (Interface) IDriverCDSV3 (Interface) IDriverCredentialsHandling (Interface) IDriverCredentialsHandlingEveryLogin (Interface) IDriverCustomRequest (Interface) IDriverLargeRequest (Interface) IDriverRequest (Interface) IDriverRequestFactory (Interface) IDriverRequestFactoryCustom (Interface) IDriverRequestFactoryLargeRequests (Interface) IDriverRequestFactoryReusable (Interface) IDriverRequestReusable (Interface) IDriverSpecificData (Interface) IDriverSpecifiedSettings (Interface) IDriverSpecifiedSettingsReadOnChange (Interface) IDriverStateMachine (Interface) IDriverStateMachine2 (Interface) IDriverStateMachineNotifyBeforeShutdown (Interface) IDriverStateMachineShutdownTimeout (Interface) IDriverTraceAddressInfoProvider (Interface) ReusableRequestOperations (Enum) ETraceAddressFlags (Enum) Errors (GVL) ICDSV3Request (Interface) ContentData (Property) ContentSize (Property) Service (Property) ServiceGroup (Property) SetContentData (Method) ICDSV3RequestHandling (Interface) CreateCDSV3Request (Method) TargetByteorder (Property) ICDSV3Response (Interface) ContentData (Property) ContentSize (Property) RawData (Property) RawSize (Property) ICDSV3ServiceWriter (Interface) ICustomRequest (Interface) ICustomRequestCallback (Interface) RequestFinished (Method) ICustomRequestHandling (Interface) ReleaseRequest (Method) ICustomResponse (Interface) IDataItemBase (Interface) ErrorCode (Property) Quality (Property) TimeStamp (Property) TypeClass (Property) IDataItemList (Interface) Clear (Method) Count (Property) CreateAndAdd (Method) GetItem (Method) IDataItemListExpanding (Interface) CreateAndAddExpanding (Method) IDataItemListPersistant (Interface) FinishedAdding (Method) Usage (Property) UsageDetails (Property) IDatasource (Interface) CustomRequestHandling (Property) EnqueueCustomRequest (Method) SetCredentialsProvider (Method) IDatasource2 (Interface) Error (Property) State (Property) IDatasource3 (Interface) SetUpdateRateReduction (Method) UpdateRate (Property) IDatasourceTraceAddressInfoProvider (Interface) CreateTraceAddressInfoWriter (Method) GetPointerSizeInBytes (Method) ReleaseTraceAddressInfoWriter (Method) IDatasourcesActionRecord (Interface) IDatasourcesFrameManager (Interface) GetCount (Method) GetReplacedPath (Method) GetReplacementInfo (Method) IDatasourcesMgr (Interface) ActionRecordDelete (Method) ActionRecordReplay (Method) ActionRecordingGetResult (Method) ActionRecordingStart (Method) AllItemsOk (Method) BeginDataConfiguration (Method) CreateItemList (Method) DeleteItemList (Method) EndDataConfiguration (Method) GetDatasource (Method) GetItemInfo (Method) ReadItemsSync (Method) ReleaseData (Method) SetCredentialsProvider (Method) UseData (Method) WriteItemsSync (Method) IDatasourcesMgr2 (Interface) AddNotificationClient (Method) CreatePersistantItemList (Method) DeletePersistantItemList (Method) GetPersistantItemList (Method) Lock (Method) PersistantItemListCount (Property) RemoveNotificationClient (Method) Unlock (Method) IDatasourcesMgr3 (Interface) UseDataExpanding (Method) IDatasourcesMgr4 (Interface) CountDatasources (Property) GetDatasourceItfByIndex (Method) INotificationClient (Interface) ListOperationDone (Method) ListOperationStart (Method) ListValueRead (Method) ListValueWrite (Method) ReadRequestDone (Method) ReadRequestStart (Method) SingleValueRead (Method) SingleValueWrite (Method) WriteRequestDone (Method) WriteRequestStart (Method) ITraceAddressInfoWriter (Interface) GetAddressFlags (Method) GetSize (Method) GetType (Method) Release (Method) WriteAddressInfo (Method) ItemAccess (Enum) ItemName (Struct) ItemNameType (Enum) ItemQuality (Enum) MonitoringState (Enum) PersistantItemListUsage (Enum) ReplacementInfo (Struct) Indices and tables ¶ 1 Based on Datasources_Itfs.library, last modified 14.03.2023, 13:34:11. LibDoc 4.4.0.0-b.27 The content file Datasources_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 14.03.2023, 13:34:11.
ICredentialsUserPassword.Password (PROP) ¶ PROPERTY Password : STRING Returns the password represented by the current implementation.
ICredentialsUserPassword.Username (PROP) ¶ PROPERTY Username : STRING Returns the username represented by the current implementation.
Drivers relevant only ¶ IDataItem (Interface) Access (Property) Assigner (Property) DriverSpecific (Property) Name (Property) SetError (Method) SizeLocal (Property) SizeRemote (Property) IDataItemValueAssigner (Interface) GetRawValue (Method) SetRawValue (Method) IDriver (Interface) CredentialsHandling (Property) DataByteOrder (Property) Init (Method) RequestFactory (Property) StateMachine (Property) TargetByteOrder (Property) IDriverCDSV3 (Interface) CanSendCDSV3CustomRequest (Method) IDriverCredentialsHandling (Interface) CredentialsNecessary (Property) SetCredentials (Method) IDriverCredentialsHandlingEveryLogin (Interface) AskCredentialsEveryLogin (Property) IDriverCustomRequest (Interface) Request (Property) Response (Property) IDriverLargeRequest (Interface) Finished (Property) IDriverRequest (Interface) IDriverRequestFactory (Interface) CreateReadRequest (Method) CreateWriteRequest (Method) ReleaseRequest (Method) IDriverRequestFactoryCustom (Interface) CreateCustomRequest (Method) IDriverRequestFactoryLargeRequests (Interface) CreateLargeReadRequest (Method) CreateLargeWriteRequest (Method) IDriverRequestFactoryReusable (Interface) CreateReusableRequest (Method) ReusableRequestsSupported (Property) IDriverRequestReusable (Interface) NextOperation (Property) IDriverSpecificData (Interface) Release (Method) IDriverSpecifiedSettings (Interface) ReconnectWaitTime (Method) TimeoutSyncShutdown (Method) IDriverSpecifiedSettingsReadOnChange (Interface) ReadOnChangeOnly (Property) IDriverStateMachine (Interface) Connecting (Method) PollRequestResult (Method) ResetAfterError (Method) SendRequest (Method) ShutdownAfterError (Property) ShuttingDown (Method) StartConnect (Method) StartShutdown (Method) IDriverStateMachine2 (Interface) WaitingForCommSetting (Method) IDriverStateMachineNotifyBeforeShutdown (Interface) BeforeShutdown (Method) IDriverStateMachineShutdownTimeout (Interface) ShutdownTimedout (Method) IDriverTraceAddressInfoProvider (Interface) CreateTraceAddressInfoWriter (Method) GetPointerSizeInBytes (Method) ReleaseTraceAddressInfoWriter (Method) ReusableRequestOperations (Enum)
IDataItem (ITF) ¶ INTERFACE IDataItem EXTENDS IDataItemBase Properties: Access Assigner DriverSpecific Name SizeLocal SizeRemote ErrorCode , inherited from IDataItemBase Quality , inherited from IDataItemBase TimeStamp , inherited from IDataItemBase TypeClass , inherited from IDataItemBase Methods: SetError Structure: Access (Property) Assigner (Property) DriverSpecific (Property) Name (Property) SetError (Method) SizeLocal (Property) SizeRemote (Property)
IDataItem.Access (PROP) ¶ PROPERTY Access : ItemAccess
IDataItem.Assigner (PROP) ¶ PROPERTY Assigner : IDataItemValueAssigner
IDataItem.DriverSpecific (PROP) ¶ PROPERTY DriverSpecific : IDriverSpecificData This property can be used by the connected driver to optionally attach some driver specific data to this item.
IDataItem.Name (PROP) ¶ PROPERTY Name : REFERENCE TO ItemName Returns a readonly reference to the name information of this item. Note Please remark that this property returns the name of the according item on the side of the connected datasource. This name might be different from the instance path it is accessible on the HMI device.
IDataItem.SetError (METH) ¶ METHOD SetError Assigns an error situation to this item. Will set IDataItemBase.ErrorCode and IDataItemBase.Quality to ItemQuality.Bad InOut: Scope Name Type Comment Input errorCode SysTypes.RTS_IEC_RESULT The error code to assign. Note It is not possible to reset an error using ERR_OK
