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

areas
An array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName.

Glossary Item Box

Places the specified process areas into the enabled state. Therefore, the server will now generate condition-related events for these conditions as long as the source itself is enabled and no containing area in its hierarchy is disabled. 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 enabled for all clients, and they will begin receiving the associated condition-related events.
Because of the global effect of this method, some event server implementers may choose not to implement it. In this case, the server should return E_NOTIMPL. A condition may be associated with multiple sources (see Section 2.4). These sources may be distributed among multiple areas. Enabling 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 enabled if its condition state is set to enabled and all areas within the hierarchy of its containing areas are enabled

Syntax

Visual Basic (Declaration) 
Public Function EnableConditionByArea( _
   ByVal areas() As String _
) As Integer
C# 
public int EnableConditionByArea( 
   string[] areas
)

Parameters

areas
An array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName.

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.