General

GetVersion

  • The GetVersion Function is useful for an easy check if the OAS Service is started and reachable.
  • Returns – 1 if service is not reachable.
  • Returns positive number of current version if successful.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

GetLicenseString

  • The GetLicenseString Function returns a string of the OAS Service license.
  • Returns “OAS Service Not Reachable” if service is not reachable.
  • Returns the license string if successful.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

GetFullyLicensed

  • The GetFullyLicensed Function returns the license status of an OAS Service.
  • Returns -1 if service is not reachable.
  • Returns 0 if the service is not yet fully licensed, running in demo mode or disabled.
  • Returns 1 if the service has been licensed.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

InRuntime

  • The InRuntime Function returns the Runtime Status of an OAS Service.
  • Returns -1 if service is not reachable.
  • Returns 0 if service is not in Runtime.
  • Returns 1 if service is in Runtime.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

StartRuntime

  • The StartRuntime Subroutine Starts the OAS Service Runtime Mode.
  • If the Service is already in Runtime Mode no method occurs.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

StopRuntime

  • The StopRuntime Subroutine Stops the OAS Service Runtime Mode.
  • If the Service is not in Runtime Mode no method occurs.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

GetMaintenanceExpiration

  • The GetMaintenanceExpiration Function returns the maintenance expiration date within the service.
  • Please note that the actual maintenance expiration is retained by the company records of Open Automation Software and the value returned may be out of date.
  • Returns string Month / Day / Year in the format of 00/00/0000.
  • Returns blank if a failure occurs.
  • 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#

GetClientUsers

  • The GetClientUsers Function returns a list of users that are currently connected to the service.
  • If there was no username specified in the client connection the string is blank for the client connection.
  • The same user may be logged in to multiple clients.
  • 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.