ICredentialsProvider.GetCredentials (METH) ¶ METHOD GetCredentials : UDINT Must return ERR_OK if called after a successfull <see cref=”IsGetCredentialsFinished”> InOut: Scope Name Type Return GetCredentials UDINT Input udiRequestId UDINT Output stUserName STRING stPassword STRING
ICredentialsProvider.IsGetCredentialsFinished (METH) ¶ METHOD IsGetCredentialsFinished : UDINT Will return ERR_OK if the request is finished, ERR_PENDING if it is not yet finished, ERR_DS_RETRYLOGIN if the login should be tried again, another error code in case of an error InOut: Scope Name Type Return IsGetCredentialsFinished UDINT Input udiRequestId UDINT
ICredentialsProvider.LoginFailed (METH) ¶ METHOD LoginFailed : UDINT Will be called when a login failed due to wrong credentials The behaviour of the datasource afterwards depends on the return value. In case of ERR_PENDING, the logincycle will be started again with a call to GetCredentials. In all other cases the driver will go to it’s error state. InOut: Scope Name Type Comment Return LoginFailed UDINT Input udiRequestId UDINT Output udiRetryWaitTime UDINT The time that is waited until the next try to login is started
ICredentialsProvider.StartGetCredentials (METH) ¶ METHOD StartGetCredentials : UDINT Will return an id of the question for credentials. This id can be used in the following calls to <see cref=”IsGetCredentialsFinished”/> InOut: Scope Name Type Comment Return StartGetCredentials UDINT Input pstDataSource POINTER TO STRING The name of the datasource Output udiErrorCode UDINT
IDataGroup (ITF) ¶ INTERFACE IDataGroup EXTENDS __SYSTEM.IQueryInterface Methods: AddItem Clear Release Use Structure: AddItem (Method) Clear (Method) Release (Method) Use (Method)
IDataGroup.AddItem (METH) ¶ METHOD AddItem : UDINT InOut: Scope Name Type Return AddItem UDINT Input pstSymbol POINTER TO STRING
IDataGroup.Clear (METH) ¶ METHOD Clear : BOOL InOut: Scope Name Type Return Clear BOOL
IDataGroup.Release (METH) ¶ METHOD Release : UDINT InOut: Scope Name Type Return Release UDINT
Data Server Interfaces Library Documentation ¶ Company System Title Data Server Interfaces Version 3.5.17.0 Categories Intern|DataServer Namespace Dataserver_Interfaces Author 3S-Smart Software Solutions GmbH Description 1 ¶ This library defines the interfaces the dataserver consists of. It is also the basis for developing own datasources. Contents: ¶ DataItemQualityCodes (GVL) DataServerFlags (Enum) DataServerRequestIdentification (Enum) DataServerSettings (GVL) DataServer_StructReplacementInfo (Struct) DataSourceShutdownFlags (Enum) DataSourceState (Enum) DataSourceTransactionResult (Enum) DriverInitConstants (GVL) DriverInitInfo (Struct) ICallback (Interface) Callback (Method) ICredentialsProvider (Interface) GetCredentials (Method) IsGetCredentialsFinished (Method) LoginFailed (Method) StartGetCredentials (Method) IDataGroup (Interface) AddItem (Method) Clear (Method) Release (Method) Use (Method) IDataItemList (Interface) Clear (Method) Count (Property) CreateAndAdd (Method) GetItem (Method) IDataServer (Interface) AllItemsOk (Method) BeginDataConfiguration (Method) EndDataConfiguration (Method) GetItemInfo (Method) ReleaseData (Method) UseData (Method) IDataServer2 (Interface) GetInterface (Method) InstancePathPrefix (Property) SetCredentialsProvider (Method) IDataServer3 (Interface) ResolveSymbol (Method) IDataServer4 (Interface) CreateItemList (Method) DeleteItemList (Method) ReadItems (Method) WriteItems (Method) IDataServer5 (Interface) DeleteRecord (Method) Flags (Property) GetRecordResult (Method) ReplayRecord (Method) ResumeAfterTempShutdown (Method) StartRecordMode (Method) StartTempShutdown (Method) IDataServer6 (Interface) GetAddress (Method) IsSwappingNeeded (Method) ProcessDataServerRequest (Method) IDataServerActionRecord (Interface) IDataServerFrameManager (Interface) GetCount (Method) GetReplacedPath (Method) GetReplacementInfo (Method) IDataSourceDriver (Interface) Connecting (Method) GetRequestResult (Method) GetSetting (Method) Initialize (Method) LastError (Property) ReadRequest (Method) Reset (Method) ShuttingDown (Method) StartConnect (Method) StartShutdown (Method) State (Property) UpdateRequest (Method) WriteRequest (Method) IDataSourceDriver2 (Interface) ShutdownFinished (Method) IDataSourceDriver3 (Interface) AssignCredentials (Method) CredentialsNeeded (Property) GetInterface (Method) IDataSourceDriver4 (Interface) ReadRequest2 (Method) WriteRequest2 (Method) IDataSourceDriver5 (Interface) IsSwappingNeeded (Method) ProcessDataServerReply (Method) ProcessDataServerRequest (Method) IGeneric (Interface) GetInterface (Method) IProvidesConcreteType (Interface) ImplementingTypeId (Property) Instance (Property) ITempShutdownResult (Interface) DataSourceName (Property) Result (Property) InterfaceIds (GVL) PlcAddressInfoUnion (Union) ReturnValues (GVL) SwappingInfo (Enum) TypeIds (Enum) Indices and tables ¶ 1 Based on DataServer_Itfs.library, last modified 20.04.2021, 14:41:29. LibDoc 4.4.0.0-b.27 The content file DataServer_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 14:41:29.
DataItemQualityCodes (GVL) ¶ InOut: Scope Name Type Initial Constant Mask_LowestLevel DWORD 16#FFFF Mask_DriverLevel DWORD 16#FF0000 Mask_ApplicationLevel DWORD 16#FF000000 AppLevel_LastUpdateFailed DWORD 16#1000000 AppLevel_Timeout DWORD 16#2000000