uaPLUS Reference
DisableConditionByArea2 Method
See Also  Send Feedback
NSPlugin Namespace > AlarmEventServer Class : DisableConditionByArea2 Method

areas
Array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName
errors
Array of HRESULTS indicating the success of placing all conditions for all sources within a specified process area into the disabled state. The errors correspond to the areas passed into the method.

Glossary Item Box

Places the specified process areas into the disabled state. Therefore, the server will now cease generating condition-related events for these conditions. The effect of this method is global within the scope of the event server. Therefore, if the server is supporting multiple clients, the conditions are disabled for all clients, and they will stop receiving the associated condition-related events.
A condition may be associated with multiple sources (see Section 2.4). These sources may be distributed among multiple areas. Disabling the conditions in one area does not change the enabled/disabled state of conditions of the same name, which are associated with sources in other areas. For example, the “LevelAlarm” condition may be enabled for sources in “Area1” and disabled for sources in “Area2”. A source is disabled if its condition state is set to disabled or any area within the hierarchy of its containing areas is disabled. If the HRESULT is a FAILED code then the server should return null (Nothing) for the OUT parameter errors.

Syntax

Visual Basic (Declaration) 
Public Function DisableConditionByArea2( _
   ByVal areas() As String, _
   ByRef errors As Integer() _
) As Integer
C# 
public int DisableConditionByArea2( 
   string[] areas,
   out int[] errors
)

Parameters

areas
Array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName
errors
Array of HRESULTS indicating the success of placing all conditions for all sources within a specified process area into the disabled state. The errors correspond to the areas passed into the method.

Requirements

Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family

See Also

© 2010-2018 Copyright Advosol Inc. All Rights Reserved.