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)
IDataItem.SizeRemote (PROP) ¶ PROPERTY SizeRemote : __UXINT Returns the size of the variable represented by this item on the remote device (the one IDriver connects to.
IDataItemValueAssigner (ITF) ¶ INTERFACE IDataItemValueAssigner EXTENDS __SYSTEM.IQueryInterface Implementations of this interface represent a mechanism for assigning values retrieved from a device connected by a IDriver to the local value or the other way round. Methods: GetRawValue SetRawValue Structure: GetRawValue (Method) SetRawValue (Method)
IDataItemValueAssigner.GetRawValue (METH) ¶ METHOD GetRawValue : POINTER TO BYTE This method can be called to retrieve the value in a form that can be written to a device connected by a IDriver from the local value InOut: Scope Name Type Comment Return GetRawValue POINTER TO BYTE A pointer to the data that should be sent. The data will be in byte order according to IDriver.DataByteOrder and the size will be the one returned by IDataItem.SizeRemote Important The returned value will not be guaranteed to be valid longer than the typically current call of IDriverStateMachine.SendRequest
IDataItemValueAssigner.SetRawValue (METH) ¶ METHOD SetRawValue This method can be called to assign a value retrieved from a device connected by a IDriver to the local value InOut: Scope Name Type Comment Input pData POINTER TO BYTE A pointer to the data retrieved from the device. The byte order is expected to be IDriver.DataByteOrder and the size is IDataItem.SizeRemote
IDriver (ITF) ¶ INTERFACE IDriver EXTENDS __SYSTEM.IQueryInterface This interface must be implemented by communication drivers that provide data for the Datasources data aquisition mechanism. Properties: CredentialsHandling DataByteOrder RequestFactory StateMachine TargetByteOrder Methods: Init Structure: CredentialsHandling (Property) DataByteOrder (Property) Init (Method) RequestFactory (Property) StateMachine (Property) TargetByteOrder (Property)
IDriver.CredentialsHandling (PROP) ¶ PROPERTY CredentialsHandling : IDriverCredentialsHandling If this kind of driver requires credentials for logging in to a specific kind of device, then this property can return an object handling the assignment of credentials.
IDriver.DataByteOrder (PROP) ¶ PROPERTY DataByteOrder : ByteOrder Returns the byteorder of value data managed by this instance. Note It is not expected that this value changes at runtime. Important Please remark that this value does not give information about the byte order used by the connected device but merely returns the information about the byteorder of data managed by IDataItemValueAssigner .
IDriver.Init (METH) ¶ METHOD Init This method passes an instance of the configuration object to the driver. The according concrete type is driver dependent and the codegeneration will allocate and initialize the configuration object accordingly before calling this method. InOut: Scope Name Type Comment Input pCFGData POINTER TO BYTE A pointer to the configuration data. This pointer can be casted to the conrete implementing type. It’s the responsibility of the drivers Automation Platform implementation to assure the correct type.