IDriverRequestFactoryCustom (ITF) ¶ INTERFACE IDriverRequestFactoryCustom EXTENDS IDriverRequestFactory Methods: CreateCustomRequest CreateReadRequest , inherited from IDriverRequestFactory CreateWriteRequest , inherited from IDriverRequestFactory ReleaseRequest , inherited from IDriverRequestFactory Structure: CreateCustomRequest (Method)
IDriverRequestFactoryCustom.CreateCustomRequest (METH) ¶ METHOD CreateCustomRequest : IDriverCustomRequest InOut: Scope Name Type Return CreateCustomRequest IDriverCustomRequest Input request ICustomRequest
IDriverRequestFactoryLargeRequests (ITF) ¶ INTERFACE IDriverRequestFactoryLargeRequests EXTENDS IDriverRequestFactory This interface can additionally be implemented by function blocks implementing IDriverRequestFactory to support reading/writing of possibly large requests that might require multiple requests. Note This feature is typically necessary for successfully reading/writing recipes Methods: CreateLargeReadRequest CreateLargeWriteRequest CreateReadRequest , inherited from IDriverRequestFactory CreateWriteRequest , inherited from IDriverRequestFactory ReleaseRequest , inherited from IDriverRequestFactory Structure: CreateLargeReadRequest (Method) CreateLargeWriteRequest (Method)
IDriverRequestFactoryLargeRequests.CreateLargeReadRequest (METH) ¶ METHOD CreateLargeReadRequest : IDriverLargeRequest Creates a request representing the read operation for the given list of items. The request may stay alive until the list of items changes. That means it might be issued in several calls to IDriverStateMachine.SendRequest When the request is no longer necessary, it will be released by a call to IDriverRequestFactory.ReleaseRequest In contrast to IDriverRequestFactory.CreateReadRequest , the resulting request might require being sent using several calls to IDriverStateMachine.SendRequest for completion. Important The items may be stored as part of the request object. Nevertheless it is not allowed to access them from other threads because the list might change within the main datasources task. The list will not change as long as this object is alive. InOut: Scope Name Type Comment Return CreateLargeReadRequest IDriverLargeRequest A new request object representing the read operation for the given list of items. Input pItems POINTER TO IDataItem A pointer to an array of IDataItem instances that should be monitored. itemsCount DINT The number of items within the array.
IDriverRequestFactoryLargeRequests.CreateLargeWriteRequest (METH) ¶ METHOD CreateLargeWriteRequest : IDriverLargeRequest Creates a request representing a write operation for the given list of items. When the request is no longer necessary, it will be released by a call to IDriverRequestFactory.ReleaseRequest In contrast to IDriverRequestFactory.CreateWriteRequest , the resulting request might require being sent using several calls to IDriverStateMachine.SendRequest for completion. Important The passed list of items must not be stored as part of the request. InOut: Scope Name Type Comment Return CreateLargeWriteRequest IDriverLargeRequest A new request object representing a write operation for the given list of items. Input pItems POINTER TO IDataItem A pointer to an array of IDataItem instances that should be written. itemsCount DINT The number of items within the array.
IDriverRequestFactoryReusable (ITF) ¶ INTERFACE IDriverRequestFactoryReusable EXTENDS IDriverRequestFactory Implementations of this interface support the creation of request objects that can be reused for issuing several read or write requests using the same object. Note The idea behind this interface is to being able to preregister a list of variables (a request from the driver’s point of view) within the connected device for quicker response times when it comes to reading/writing because symbolic resolutions etc. can be done before. Properties: ReusableRequestsSupported Methods: CreateReusableRequest CreateReadRequest , inherited from IDriverRequestFactory CreateWriteRequest , inherited from IDriverRequestFactory ReleaseRequest , inherited from IDriverRequestFactory Structure: CreateReusableRequest (Method) ReusableRequestsSupported (Property)
SortByAddrItemHelper.CompareToByReadListIndex (METH) ¶ METHOD CompareToByReadListIndex : DINT Compares this element with pOther. Returns 0 if the elements are equal, < 0 if the element is less than itfElement, > 0 if the element is greater than itfElement. This method will be called from sorted collections (e.g. |SortedList| ) to sort elements. IMPORTANT: The underlying value to be compared with MUST NOT be changed during the lifecycle of the object. InOut: Scope Name Type Return CompareToByReadListIndex DINT Input pOther POINTER TO SortByAddrItemHelper
StringBuilderSysMemExtending.FB_Init (METH) ¶ METHOD FB_Init : BOOL InOut: Scope Name Type Return FB_Init BOOL Input bInitRetains BOOL bInCopyCode BOOL
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.
