Driver Interfaces

Please note that the most efficient way to add tags and set their properties programmatically is using the DriverInterfaceCSVImport method.

GetDriverInterfaceNames

  • The GetDriverInterfaceNames Function returns a list of the Driver Interfaces.
  • Returns Empty String Array if service is not reachable.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#

RemoveDriverInterface

  • The RemoveDriverInterface Function removes a Driver Interface Group from the existing Driver Interface configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Driver Interface does not exist or removing the Driver Interface failed.
  • Name is the name of the Driver Interface to remove.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#

GetDriverInterfaceParameterStrings

  • The GetDriverInterfaceParameterStrings Function returns an array of Strings containing all property types available for each Driver Interface Group.
  • Returns Empty String Array if service is not reachable.
  • Returns a String Array of property types for all possible Parameters for a Driver Interface Group.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#

GetDriverInterface_Parameter_Value

  • The GetDriverInterface_Parameter_Value Function returns an object value for the Driver Interface Group and Parameter specified.
  • Returns nothing if service is not reachable.
  • Parameter is a String of the Parameter Type desired of the Driver Interface Group.
  • Name is a String of the Driver Interface Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#

GetDriverInterface_Parameter_Values

  • The GetDriverInterface_Parameter_Values Function returns an array of object values for the Driver Interface Group specified.
  • The order of the array corresponds with the GetDataLoggingParameterStrings Function order.
  • Returns empty array if service is not reachable.
  • Name is a String of the Driver Interface Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#

SetDriverInterface_Parameter_Value

  • The SetDriverInterface_Parameter_Value Function sets an object value for the Driver Interface Group and Parameter specified.
  • If the Driver Interface specified does not exist it will be added.
  • Returns -1 if service is not reachable.
  • Returns 0 if the value did not get set correctly.
  • Returns 1 if the function was successful.
  • Parameter is a String of the Parameter Type desired of the Driver Interface Group.
  • Value is the desired value to set.
  • Name is a String of the Driver Interface Group desired.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • ErrorString will be set to Success when function is successful and an error message when in error.
  • RemoteSCADAHostingName is the name of the Live Data Cloud OAS Service to connect to.

VB

C#