Tag Groups

GetGroupNames

  • The GetGroupNames Function returns a list of Groups in the specified ReferenceGroup path.
  • Returns Empty String Array if service is not reachable.
  • Returns a String Array of Groups in the ReferenceGroup.
  • ReferenceGroup is a string of the Group path to retrieve the Groups from.
  • 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#

 

AddGroup

  • The AddGroup Function adds a Group to the existing Tag configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Group already exists or adding the Group failed.
  • Group is the name of the Group to add.
  • ReferenceGroup is a string of the Group path to add the Group to.
  • 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#

 

RemoveGroup

  • The RemoveGroup Function removes a Group to the existing Tag configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Group does not exist or removing the Group failed.
  • Group is the name of the Group to remove.
  • ReferenceGroup is a string of the Group path to remove the Group from.
  • 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#

 

RenameGroup

  • The RenameGroup Function renames an existing Group in the Tag configuration.
  • Returns -1 if service is not reachable.
  • Returns 1 if successful.
  • Returns 0 if the Old Group does not exist, the New Group already exists, or renaming the Group failed.
  • OldGroup is the name of the existing Group to rename.
  • NewGroup is the name to change the Group to.
  • ReferenceGroup is a string of the Group path to rename the Group in.
  • 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#

 

GetAllAlarmGroups

  • The GetAllAlarmGroups Function returns a list of Alarm Groups in the current Tag Configuration.
  • 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.
  • Optional ErrorString will be set to Success when function is successful and an error message is in error.

VB

C#