Alarm Notification Groups

Use the OPC Systems component in your Visual Studio application to programmatically modify alarm notification groups. Refer to the FormConfigureAlarmNotification Form in the WinForm Example Code example for an example and how to add and modify alarm logging groups.

GetAlarmNotificationNames

The GetAlarmNotificationNames Function returns a list of the Alarm Notification 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#

AddAlarmNotificationGroup

The AddAlarmNotificationGroup Function adds a Alarm Notification Group to the existing Alarm Notification 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#

RemoveAlarmNotificationGroup

The RemoveAlarmNotificationGroup Function removes a Alarm Notification Group from the existing Alarm Notification 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#

GetAlarmNotificationParameterStrings

The GetAlarmNotificationParameterStrings Function returns an array of Strings containing all property types available for each Alarm Notification Group.

Returns Empty String Array if service is not reachable.

Returns a String Array of property types for all possible Parameters for a Alarm Notification Group.

NetworkNode is the name of the network node of the OAS Service to connect to. Leave blank for localhost connection.

VB

C#

GetAlarmNotification_Parameter_Value

The GetAlarmNotification_Parameter_Value Function returns an object value for the Alarm Notification Group and Parameter specified.

Returns nothing if service is not reachable.

Parameter is a String of the Parameter Type desired of the Alarm Notification Group.

Group is a String of the Alarm Notification 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#

GetAlarmNotification_Parameter_Values

The GetAlarmNotification_Parameter_Values Function returns an array of object values for the Alarm Notification Group specified.

The order of the array corresponds with the GetAlarmNotificationParameterStrings Function order.

Returns empty array if service is not reachable.

Group is a String of the Alarm Notification 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

SetAlarmNotification_Parameter_Value

The SetAlarmNotification_Parameter_Value Function sets an object value for the Alarm Notification 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 Notification Group.

Value is the desired value to set.

Group is a String of the Alarm Notification 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#

SaveAlarmNotificationConfiguration

The SaveAlarmNotificationConfiguration Subroutine saves the current Alarm Notification 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

LoadAlarmNotificationConfiguration

The LoadAlarmNotificationConfiguration Subroutine saves the current Alarm Notification 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#