Datasources (LIB)

Version

4.6.0.0

Namespace

Datasources

Author

CODESYS Development GmbH

Placeholder

Datasources

Description 1

Library implementing the kernel part of the datasources feature.

Contents:

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

Indices and tables

1

Based on Datasources.library, last modified 12.05.2025, 07:53:43. LibDoc 4.6.0.0-r.29

The content file Datasources.library.json was generated with CODESYS V3.5 SP16 Patch 3 on 12.05.2025, 07:53:47.