Alarm Logging Groups – VB & C#

Code examples for VB and C# environments

GetAlarmLoggingNames

  • The GetAlarmLoggingNames Function returns a list of the Alarm Logging Groups.
  • 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 when in error.

VB

C#

 

AddAlarmLoggingGroup Function

  • The AddAlarmLoggingGroup Function adds a Alarm Logging Group to the existing Alarm Logging 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.
  • 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#

 

RemoveAlarmLoggingGroup

  • The RemoveAlarmLoggingGroup Function removes a Alarm Logging Group from the existing Alarm Logging 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.
  • 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#

 

GetAlarmLoggingParameterStrings

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

VB

C#

 

GetAlarmLogging_Parameter_Value

  • The GetAlarmLogging_Parameter_Value Function returns an object value for the Alarm Logging Group and Parameter specified.
  • Returns nothing if service is not reachable. ‘ Parameter is a String of the Parameter Type desired of the Alarm Logging Group.
  • Group is a String of the Alarm Logging Group desired.
  • 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#

 

GetAlarmLogging_Parameter_Values

  • The GetAlarmLogging_Parameter_Values Function returns an array of object values for the Alarm Logging Group specified.
  • The order of the array corresponds with the GetAlarmLoggingParameterStrings Function order.
  • Returns empty array if service is not reachable.
  • Group is a String of the Alarm Logging Group desired.
  • 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#

 

SetAlarmLogging_Parameter_Value

  • The SetAlarmLogging_Parameter_Value Function sets an object value for the Alarm Logging Group and Parameter specified.
  • Returns -1 if service is not reachable.
  • Returns 0 if the Group does not exist or 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 Alarm Logging Group.
  • Value is the desired value to set.
  • Group is a String of the Alarm Logging Group desired.
  • 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#

 

SaveAlarmLoggingConfiguration

  • The SaveAlarmLoggingConfiguration Subroutine saves the current Alarm Logging configuration to the specified file path.
  • 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#

 

LoadAlarmLoggingConfiguration

  • The LoadAlarmLoggingConfiguration Subroutine saves the current Alarm Logging configuration to the specified file path.
  • NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#