Datasources Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title Datasources Version 4.3.0.0 Categories Intern|DataSources Namespace Datasources Author 3S - Smart Software Solutions GmbH Placeholder Datasources Description 1 ¶ Library implementing the kernel part of the datasources feature. Contents: ¶ DataSourcesQualityChecker (FunctionBlock) DataSources_PRG (Program) Datasources Enums Function Blocks Functions GlobalConstants GlobalVariables Interfaces Structs Tests Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Indices and tables ¶ 1 Based on Datasources.library, last modified 14.03.2023, 13:32:56. LibDoc 4.4.0.0-b.27 The content file Datasources.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 14.03.2023, 13:32:56.

DataSourcesQualityChecker (FB) ¶ FUNCTION_BLOCK DataSourcesQualityChecker This utility function block can be used for concurrently checking the quality of currently monitored items by all datasources. InOut: Scope Name Type Initial Comment Input iMaxLockedCount INT 3 The maximal number of subsequently allowed problems (due to multitasking issues) with asking the datasourcesmanager if all items are ok. If the value is <= 0, then the locked state will be returned as everything is ok. ds IDatasources.IDatasourcesMgr The instance of the datasources manager, typically g_Datasources Output xAllOk BOOL Whether all items are ok xTooManyTimesLocked BOOL Whether the dataserver has been locked too often xErrorParameter BOOL The parameters are invalid

DataSources_PRG (PRG) ¶ PROGRAM DataSources_PRG InOut: Scope Name Type Input ptaskinfo POINTER TO DWORD papplicationinfo POINTER TO _IMPLICIT_APPLICATION_INFO

Datasources ¶ Enums DataSourceError (Enum) DataSourceMonitoringState (Enum) DataSourceState (Enum) DatasourcesAction (Enum) Function Blocks AskCredentialsHelper (FunctionBlock) LoginFailed (Method) SetCredentialsProvider (Method) Assigners AssignerBase (FunctionBlock) AssignReadValue (Method) AtomicAssignIfPossible (Method) FB_Exit (Method) GetBitValuePtr (Method) GetRawValue (Method) IsValueForBitAssignment (Property) SetRawValue (Method) DirectAssigner (FunctionBlock) GetRawValue (Method) SetRawValue (Method) ILocalAssigner (Interface) FB_Exit (Method) SwappedDirectAssigner (FunctionBlock) DoSwapValueBuffer (Method) GetRawValue (Method) SetRawValue (Method) Collections CustomRequestQueue (FunctionBlock) FB_Exit (Method) FB_Init (Method) Override abstrAssign (Method) abstrDataPtrChanged (Method) abstrGetElementPtr (Method) abstrSizeOfElement (Method) DataItemAndPtrVectors (FunctionBlock) AddItem (Method) Clear (Method) Count (Property) FB_Exit (Method) GetArrayPtr (Method) Remove (Method) DataItemListPublic (FunctionBlock) FB_Exit (Method) IDataIemListInternal Release (Method) IDataItemList Clear (Method) Count (Property) CreateAndAdd (Method) GetItem (Method) IDataItemListExpanding CreateAndAddExpanding (Method) Internal Initialize (Method) Protected CanItemBeAdded (Method) DataItemListPublicPersistant (FunctionBlock) FB_Exit (Method) IDataItemListPersistant FinishedAdding (Method) Usage (Property) UsageDetails (Property) Internal Initialize (Method) Protected CanItemBeAdded (Method) DataItemPtrVector (FunctionBlock) AddItem (Method) GetItem (Method) Remove (Method) DataItemVector (FunctionBlock) AddItem (Method) GetArrayPtr (Method) GetItem (Method) Remove (Method) abstrAssign (Method) abstrDataPtrChanged (Method) abstrGetElementPtr (Method) abstrSizeOfElement (Method) DintSetBitBased (FunctionBlock) AddDint (Method) Clear (Method) Contains (Method) DintSetFull (FunctionBlock) AddDint (Method) Contains (Method) IDintSet (Interface) AddDint (Method) Clear (Method) Contains (Method) IPStringAndIntElement (Interface) IPStringElement (Interface) PStringValue (Property) PStringElement (FunctionBlock) ElementCompareTo (Method) ElementEquals (Method) ElementHashCode (Method) PStringValue (Property) PStringElementFactory (FunctionBlock) Create (Method) prvInstCount (Property) prvInstPoolExtendsFactor (Property) prvInstSize (Property) Components ComponentBase (FunctionBlock) BitOffset (Property) QueryInterface (Method) ComponentPseudo (FunctionBlock) QueryInterface (Method) ComponentRenamed (FunctionBlock) QueryInterface (Method) RemoteName (Property) ComponentSimple (FunctionBlock) CredentialsProviders StaticCredentialsProvider (FunctionBlock) ICredentialsProvider GetCredentials (Method) IsGetCredentialsFinished (Method) LoginFailed (Method) LoginSucceeded (Method) StartGetCredentials (Method) ICredentialsUserPassword Password (Property) Username (Property) DataItem (FunctionBlock) FB_Exit (Method) IDataItem Assigner (Property) DriverSpecific (Property) SetError (Method) SizeLocal (Property) SizeRemote (Property) IDataItemBase ErrorCode (Property) Quality (Property) TimeStamp (Property) Internal SetErrorHelp (Method) SetErrorNoLog (Method) ValueAddress (Property) WriteCopyAddress (Property) DataItemBase (FunctionBlock) FB_Exit (Method) IDataItem-parts Name (Property) IElement ElementCompareTo (Method) ElementEquals (Method) ElementHashCode (Method) DataItemList (FunctionBlock) AddItem (Method) AssureReadOnlyHaveWriteCopy (Method) Clear (Method) FillReadOnlyList (Method) GetPendingWriteVars (Method) GetReadVars (Method) ResetModifiedReadonlyItems (Method) DataItemLocation (FunctionBlock) AssureWriteCopy (Method) BitOffset (Property) FB_Exit (Method) Init (Method) LocalAddress (Property) SizeLocal (Property) SizeRemote (Property) WriteCopyAddress (Property) Datasource (FunctionBlock) Cyclic (Method) FB_Exit (Method) ICDSV3RequestHandling CreateCDSV3Request (Method) ReleaseRequest (Method) TargetByteOrder (Property) IDatasource CustomRequestHandling (Property) EnqueueCustomRequest (Method) SetCredentialsProvider (Method) IDatasource2 Error (Property) State (Property) IDatasource3 SetUpdateRateReduction (Method) UpdateRate (Property) IDatasourceTraceAddressInfoProvider CreateTraceAddressInfoWriter (Method) GetPointerSizeInBytes (Method) ReleaseTraceAddressInfoWriter (Method) Init (Method) Internal SetDatasourceIndex (Method) ItemList (Property) ListChangesDone (Method) ListChanging (Method) Private UpdateWriteCopies (Method) RunWhileStopped (Property) ShutdownInfo (Property) StartShutdown (Method) DatasourceShutdownInfo (FunctionBlock) BeforeShutdown (Method) Done (Method) Init (Method) ShutdownDone (Property) Timedout (Method) TimeoutValue (Property) DatasourcesActionRecord (FunctionBlock) AddEntry (Method) BeginUpdate (Method) Count (Property) EndUpdate (Method) FB_Exit (Method) GetEntry (Method) Release (Method) DatasourcesMgr (FunctionBlock) Cyclic (Method) FB_Exit (Method) ICmpEventCallback EventCallback (Method) IDataSourcesMgr Action Records ActionRecordDelete (Method) ActionRecordReplay (Method) ActionRecordingGetResult (Method) ActionRecordingStart (Method) AllItemsOk (Method) BeginDataConfiguration (Method) EndDataConfiguration (Method) GetDatasource (Method) GetItemInfo (Method) ItemList CreateItemList (Method) DeleteItemList (Method) ReadItemsSync (Method) ReleaseData (Method) SetCredentialsProvider (Method) UseData (Method) WriteItemsSync (Method) IDatasourcesMgr2 AddNotificationClient (Method) CreatePersistantItemList (Method) DeletePersistantItemList (Method) GetPersistantItemList (Method) Lock (Method) PersistantItemListCount (Property) RemoveNotificationClient (Method) Unlock (Method) IDatasourcesMgr3 UseDataExpanding (Method) IDatasourcesMgr4 CountDatasources (Property) GetDatasourceItfByIndex (Method) IDatasourcesMgrInternal CreateItemFromSymbolinfo (Method) NotificationClient (Property) Init (Method) Internal GetItemInfoWithDatasourceIndex (Method) GetPersistantItemListImpl (Method) ReleaseDataWithDatasourceIndex (Method) UseDataWithDatasourceIndex (Method) Private ActivateDefaultUpdateItems (Method) AreAllShutdown (Method) DeriveMaxShutdownTimeoutValue (Method) ExistsPersistantItemList (Method) InitSources (Method) ReadWriteItemsSyncHelp (Method) Releasing ReleaseEvents (Method) TriggerStartShutdownComm (Method) UpdateLists (Method) Frameswitching FrameManager (FunctionBlock) GetCount (Method) GetReplacedPath (Method) GetReplacementInfo (Method) Initialize (Method) Mappings MappingDesc_ArrayArbitrary (FunctionBlock) FindChild (Method) protTokenLength (Method) MappingDesc_ArraySubRange (FunctionBlock) protDoNotifyArrayAccess (Method) Nodefinding OurVarInfo (FunctionBlock) AccessRights (Property) ArrayAccessDetected (Method) SetArrayNotificationClient (Method) Requests CDSV3Request (FunctionBlock) ContentData (Property) ContentSize (Property) FB_Exit (Method) Service (Property) ServiceGroup (Property) SetContentData (Method) SetInfo (Method) Roots RootDatasourceIndex (FunctionBlock) DatasourceIndex (Property) IsMapped (Property) QueryInterface (Method) RootPseudo (FunctionBlock) QueryInterface (Method) RootRenamed (FunctionBlock) QueryInterface (Method) RemoteName (Property) RootRenamedDatasourceIndex (FunctionBlock) BitOffset (Property) DatasourceIndex (Property) IsMapped (Property) QueryInterface (Method) Utils AffectedSourcesHelp (FunctionBlock) Initialize (Method) Sources (Property) GetBitValue (Function) Logging Assert (Function) ComponentConstants (GVL) ErrorToString (Function) LogComponent (FunctionBlock) FB_Exit (Method) FB_Init (Method) PtrToString (Function) Severity (Enum) ValueToString (Function) Memory StatDynMemory (FunctionBlock) FB_Exit (Method) FB_Init (Method) Ptr (Property) Reserve (Method) QuickSortAddrItemHelpers (FunctionBlock) SetBitValue (Function) SettingValue (FunctionBlock) ValueAsTime (Property) SettingsHelper (FunctionBlock) ReconnectWaitTime (Method) TimeoutSyncShutdown (Method) SortByAddrItemHelper (FunctionBlock) CompareToByAddrAndSize (Method) CompareToByReadListIndex (Method) StringBuilderSysMemExtending (FunctionBlock) FB_Init (Method) Functions AllocAndCopyPString (Function) CompatibilitySafeGetPrepareExitCommProcessingLastCall (Function) CompatibilitySafeSetPrepareExitCommProcessingFurtherCallNecessary (Function) GlobalConstants InterfaceIds (GVL) InternalConstants (GVL) SpecialChars (GVL) GlobalVariables ErrorSituationTests (GVL) GVL (GVL) Settings (GVL) Interfaces IDataItemCompound (Interface) IDataItemListInternal (Interface) Release (Method) IDatasourcesActionRecordInternal (Interface) Count (Property) GetEntry (Method) Release (Method) IExpandSubNodeAdapterSingleRelease (Interface) ReleaseSubNode (Method) IProvidesBitOffset (Interface) BitOffset (Property) IProvidesDifferentRemoteName (Interface) RemoteName (Property) IProvidesRootInfo (Interface) DatasourceIndex (Property) IsMapped (Property) IPseudoNode (Interface) IUseDataContextSubNodes (Interface) NodeFinder (Property) PathOffset (Property) Structs AllScalarsUnion (Union) Datasources (Struct) EnqueuedRequest (Struct) FrameRegistrationData (Struct) ReusableRequestInfo (Struct) SymbolInfo (Struct) UpdateByDefaultInfo (Struct) UpdateByDefaultItem (Struct) Tests Test (Program)

StateMachine.DisconnectSync (METH) ¶ METHOD DisconnectSync

StateMachine.Connecting (METH) ¶ METHOD Connecting : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Return Connecting SysTypes.RTS_IEC_RESULT

StateMachine.PollRequestResult (METH) ¶ METHOD PollRequestResult : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Return PollRequestResult SysTypes.RTS_IEC_RESULT Input request IDatasources.IDriverRequest

StateMachine.ResetAfterError (METH) ¶ METHOD ResetAfterError

StateMachine.SendRequest (METH) ¶ METHOD SendRequest : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Return SendRequest SysTypes.RTS_IEC_RESULT Input request IDatasources.IDriverRequest

StateMachine.ShutdownAfterError (PROP) ¶ PROPERTY ShutdownAfterError : BOOL