SwapWordIf (FUN) ¶ FUNCTION SwapWordIf : WORD InOut: Scope Name Type Return SwapWordIf WORD Input w WORD byteOrder IDatasources.ByteOrder
UtilSwapGuidIf (FUN) ¶ FUNCTION UtilSwapGuidIf : BOOL InOut: Scope Name Type Return UtilSwapGuidIf BOOL Inout theguid Guid Input byteOrder IDatasources.ByteOrder
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.
StateMachine.ShutdownAfterError (PROP) ¶ PROPERTY ShutdownAfterError : BOOL This property returns TRUE when the shutdown sequence should be called after a previous error. The property will be evaluated after there was an error return from one of the state machine methods.
StateMachine.ShutdownTimedout (METH) ¶ METHOD ShutdownTimedout Called when the shutdown operation timed out.
StateMachine.ShuttingDown (METH) ¶ METHOD ShuttingDown : SysTypes.RTS_IEC_RESULT This method is called during the shutdown sequence. Implementations can use it to implement the shutdown sequence (like loggint out from the connected device, closing connection resources etc.) InOut: Scope Name Type Comment Return ShuttingDown SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. In case the sequence is not yet finished, CmpErrors.Errors.ERR_PENDING should be returned. After a successfull or failed return, the implementation should be in a state where a new connection could be setup using a possible followup call to |IDriverStateMachine.StartConnect| .
StateMachine.StartConnect (METH) ¶ METHOD StartConnect : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Comment Return StartConnect SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. Please remark that this operation is not expected to return CmpErrors.Errors.ERR_PENDING. A successfull return (CmpErrors.Errors.ERR_OK) of this method will then cause followup calls to |IDriverStateMachine.Connecting| .
StateMachine.StartShutdown (METH) ¶ METHOD StartShutdown : SysTypes.RTS_IEC_RESULT This method is called to start the shutdown sequence. Implementations can use it to start logging out from the connected device for example. This method is not called while a request is pending. InOut: Scope Name Type Comment Return StartShutdown SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case an error happens, an according eror code should be returned. Please remark that this operation is not expected to return CmpErrors.Errors.ERR_PENDING. A successfull return (CmpErrors.Errors.ERR_OK) of this method will then cause followup calls to |IDriverStateMachine.ShuttingDown| .
StateMachine.WaitingForCommSetting (METH) ¶ METHOD WaitingForCommSetting : SysTypes.RTS_IEC_RESULT Waiting for communication settings InOut: Scope Name Type Return WaitingForCommSetting SysTypes.RTS_IEC_RESULT Input xPreview BOOL
StateMachine.FillAddress (METH) ¶ METHOD FillAddress : SysTypes.RTS_IEC_RESULT InOut: Scope Name Type Return FillAddress SysTypes.RTS_IEC_RESULT Inout Const ni CmpNameServiceClientIec.NSC_CompleteNodeInfo Inout addr STRING