UtilSwapGuidIf (FUN) ¶ FUNCTION UtilSwapGuidIf : BOOL InOut: Scope Name Type Return UtilSwapGuidIf BOOL Inout theguid Guid Input byteOrder IDatasources.ByteOrder
StateMachine.Connecting (METH) ¶ METHOD Connecting : SysTypes.RTS_IEC_RESULT Using this method the driver is polled whether the startup of the connection is already finshed. InOut: Scope Name Type Comment Return Connecting SysTypes.RTS_IEC_RESULT An error code representing the result of the polling operation. In case the operation is not yet finished, CmpErrors.Errors.ERR_PENDING should be returned. When it finished successfully, CmpErrors.Errors.ERR_OK should be returned. When connecting failed, an error code should be returned and then the whole connection will be set up again.
StateMachine.PollRequestResult (METH) ¶ METHOD PollRequestResult : SysTypes.RTS_IEC_RESULT Using this method the driver is polled whether the given request is already finshed. InOut: Scope Name Type Comment Return PollRequestResult SysTypes.RTS_IEC_RESULT An error code representing the result of the polling operation. In case the operation is not yet finished, CmpErrors.Errors.ERR_PENDING should be returned. When it finished successfully, CmpErrors.Errors.ERR_OK should be returned. When sending a request failed, an error code should be returned and then the whole connection will be set up again. Input request IDatasources.IDriverRequest The request object to check for it’s result
Enums ¶ DataSourceError (Enum) DataSourceMonitoringState (Enum) DataSourceState (Enum) DatasourcesAction (Enum)
DataSourceError (ENUM) ¶ TYPE DataSourceError : Is used to monitor the error information of a data source for the data source editor or in an IEC application Attributes: qualified_only InOut: Name Initial Ok 16#0 Failed 16#1 Pending 16#A NumPending 16#B NotSupported 16#18 NotInitialized 16#3 NoMemory 16#11 LoginFailed 16#2101 NotReachable 16#2104 Duplicate 16#2105 NoSymbols 16#2106 Busy 16#2103 IdentityMismatch 16#2100 LoginNecessary 16#2102 ConnectionLost 16#2107 ConnectionDenied 16#2108 ConnectionDeniedSrvResources 16#2109
DataSourceMonitoringState (ENUM) ¶ TYPE DataSourceMonitoringState : 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 Initial Comment Initialized 0 Left after a call to StartConnect Connecting 1 Switches to Connected after succeeded Connecting and to WaitingForReconnect after errors Connected 2 The datasource is connected ShuttingDown 3 Left to Shutdown after succeeded call to ShuttingDown Shutdown 4 Terminal state WaitingForReconnect 5 Left after some time in favor of Initialized WaitingForCommSetting 6 Waiting that dynamic configuration setting has been ready
DataSourceState (ENUM) ¶ TYPE DataSourceState : Attributes: qualified_only InOut: Name Comment Initialized Left after a call to StartConnect Connecting Switches to Ready after succeeded Connecting and to WaitingForReconnect after errors Ready Left to Busy when Requests are under way, Left to ShuttingDown after succeeded StartShutdown Busy Left to Ready after finished request and to WaitingForReconnect after errors SetupBusy Alternative state to Busy for informative purposes. Typically reached for possible longer running initialization requests (like registering variable lists) ShuttingDown Left to Shutdown after succeeded call to ShuttingDown Shutdown Terminal state ShuttingDownThenReconnect Entered on errors that expect a shutdown afterwards, Left to WaitingForReconnect after succeeded call to ShuttingDown WaitingForReconnect Left after some time in favor of Initialized WaitingForCommSetting Waiting that dynamic configuration setting has been ready
DatasourcesAction (ENUM) ¶ TYPE DatasourcesAction : Attributes: qualified_only InOut: Name None Use UseExpanding Release
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)
AskCredentialsHelper (FB) ¶ FUNCTION_BLOCK AskCredentialsHelper InOut: Scope Name Type Input optCredentialsProvider IDatasources.ICredentialsProvider Methods: LoginFailed SetCredentialsProvider Structure: LoginFailed (Method) SetCredentialsProvider (Method)