Credentials ¶ ICredentials (Interface) ICredentialsProvider (Interface) GetCredentials (Method) IsGetCredentialsFinished (Method) LoginFailed (Method) LoginSucceeded (Method) StartGetCredentials (Method) ICredentialsUserPassword (Interface) Password (Property) Username (Property)
ByteOrder (ENUM) ¶ TYPE ByteOrder : This enumeration represents the byteorder of a system. It can be used as well as information about the general byte order used by a concrete system or only for data exchanged between IDataSourcesMgr and IDriver . Attributes: qualified_only InOut: Name Comment Unknown The byteorder of the system has not yet been determined. Host Data is in the byteorder of the machine running IDataSourcesMgr and IDriver Intel Data is in Intel (Little-Endian) byte order Motorola Data is in Motorola (Big-Endian) byte order
ICredentials (ITF) ¶ INTERFACE ICredentials EXTENDS __SYSTEM.IQueryInterface The base interface representing credentials. Concrete implementations might represent a combination of username/password, simply a password, a path of a private key or what ever.
ICredentialsProvider (ITF) ¶ INTERFACE ICredentialsProvider EXTENDS __SYSTEM.IQueryInterface This interface can be used in case it is necessary to provide credentials for the login to a specific type of device. Methods: GetCredentials IsGetCredentialsFinished LoginFailed LoginSucceeded StartGetCredentials Structure: GetCredentials (Method) IsGetCredentialsFinished (Method) LoginFailed (Method) LoginSucceeded (Method) StartGetCredentials (Method)
ICredentialsProvider.GetCredentials (METH) ¶ METHOD GetCredentials : SysTypes.RTS_IEC_RESULT Must return ERR_OK if called after a successfull ICredentialsProvider.IsGetCredentialsFinished InOut: Scope Name Type Comment Return GetCredentials SysTypes.RTS_IEC_RESULT Input uxiRequestId __UXINT The request id to get the credentials for Output credentials ICredentials The resulting credentials of the current implementation. Note Please remark that the returned object is not required to be alive longer than to the next calls on this object using the interface ICredentialsProvider
ICredentialsProvider.IsGetCredentialsFinished (METH) ¶ METHOD IsGetCredentialsFinished : SysTypes.RTS_IEC_RESULT 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 Comment Return IsGetCredentialsFinished SysTypes.RTS_IEC_RESULT Input uxiRequestId __UXINT The request id to check the result for
ICredentialsProvider.LoginFailed (METH) ¶ METHOD LoginFailed : SysTypes.RTS_IEC_RESULT 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 SysTypes.RTS_IEC_RESULT Input uxiRequestId __UXINT Output tRetryWaitTime TIME The time that is waited until the next try to login is started
ICredentialsProvider.LoginSucceeded (METH) ¶ METHOD LoginSucceeded Will be called when after a successful login. InOut: Scope Name Type Input uxiRequestId __UXINT
ICredentialsProvider.StartGetCredentials (METH) ¶ METHOD StartGetCredentials : __UXINT Will return an id of the question for credentials. This id can be used in the following calls to ICredentialsProvider.IsGetCredentialsFinished InOut: Scope Name Type Comment Return StartGetCredentials __UXINT Input pstDataSource POINTER TO STRING The name of the datasource to request credentials for. Can be used as an informative hint to the user for example. Output udiErrorCode SysTypes.RTS_IEC_RESULT An error code representing the result of this operation. In case of ERR_PENDING there will be further calls to this method.
ICredentialsUserPassword (ITF) ¶ INTERFACE ICredentialsUserPassword EXTENDS ICredentials An implementation of credentials that represents a username and a password. Properties: Password Username Structure: Password (Property) Username (Property)
