OPC Browsing

GetListOfOPCServers

  • The GetListOfOPCServers Function returns a list of Registered OPC Servers from the Network Node as a String Array.
  • Returns empty String Array if no Registered Servers are found.
  • Returns Nothing if the OAS Service is not reachable.
  • 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#

GetOPCBranches

  • The GetOPCBranches Function returns a list of Branches from the OPC Servers as a String Array.
  • Returns empty String Array if no Branches are found.
  • Returns Nothing if the OAS Service is not reachable.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • OPCServer is the name of the OPC Server to browse.
  • ReferencePath is a string of the branches path to browse.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

GetOPCBranchesWithDisplayNames

  • The GetOPCBranchesWithDisplayNames Function returns a list of Branches from the OPC Servers both Display Names and Actual Names as a String Array.
  • Returns empty String Array if no Branches are found or if the OAS Service is not reachable.
  • OPCServer is the name of the OPC Server to browse.
  • ReferencePath is a string of the branches path to browse.
  • 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#

GetOPCItems

  • The GetOPCItems Function returns a list of Items from the OPC Servers as a String Array.
  • Returns both the Display Name and Qualified Item Path of each OPC Item.
  • Returns empty String Array if no Items are found.
  • Returns Nothing if the OAS Service is not reachable.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.
  • OPCServer is the name of the OPC Server to browse.
  • ReferencePath is a string of the branches path to browse.
  • Optional ErrorString will be set to Success when function is successful and an error message when in error.

VB

C#

GetOPCItemsAll

  • The GetOPCItemsAll Function returns a list of all OPC Items from an OPC Server from the starting branch as a String Array.
  • Returns both the Display Name and the Qualified Item Path of each OPC Item.
  • Returns empty String Array if no Items are found or the OAS Service is not reachable.
  • OPCServer is the name of the OPC Server to browse.
  • ReferencePath is a string of the starting branch to browse. Leave blank if you want all items from the OPC Server
  • 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#

GetOPCItemProperties

  • The GetOPCItemProperties Function returns the values for the properties of the OPC Item specified as an Object Array.
  • Returns the array of values for the properties specified.
  • The length of the array returned is always 6. The values returned within the array depend on if the property attributes are set to be returned.
  • Element 0 = Data Type.
    • 0 = Double Float
    • 1 = Single Float
    • 2 = Signed Byte
    • 3 = Unsigned Byte
    • 4 = Short Integer
    • 5 = Unsigned Short Integer
    • 6 = Integer
    • 7 = Unsigned Integer
    • 8 = Long Integer
    • 9 = Unsigned Long Integer
    • 10 = Boolean
    • 11 = String
    • 12 = Array Double
    • 13 = Array Integer
    • 14 = Array String
    • 15 = Array Single
    • 16 = Array Byte
    • 17 = Array Bool
    • 18 = Object Type
  • Element 1 = Scan Rate.
  • Element 2 = Description.
  • Element 3 = Units.
  • Element 4 = Enumated Value.
  • Element 5 = Enumartion Strings, each one seperated by semicolon.
  • Returns empty Object Array if the OPC Item is not found or the OAS Service is not reachable.
  • OPCItem is the name of the OPC Server and OPC Item to get the properties from. The syntax is OPCServerOPCItem.
  • ReturnDataType should be set to True to return the Data Type
  • ReturnScanRate should be set to True to return the Scan Rate
  • ReturnDescription should be set to True to return the Description
  • ReturnUnits should be set to True to return the Units
  • ReturnEnumeratedValue should be set to True to return the Is Enemurated Value and the Enumerated Strings
  • 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#