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.
A condition may be associated with multiple sources (see Section 2.4). Enabling conditions associated with one source does not change the enabled/disabled state of conditions of the same name, which are associated with other sources. For example, the “LevelAlarm” condition may be enabled for “A100” and disabled for “FIC101”. A source is enabled if its condition state is set to enabled and all areas within the hierarchy of its containing areas are enabled. If the HRESULT is S_OK, then Errors can be ignored (all results in it are guaranteed to be S_OK). If the HRESULT is a FAILED code then the server should return a null (Nothing) for the OUT parameter, errors.
Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Function EnableConditionByArea2( _ ByVal areas() As String, _ ByRef errors As Integer() _ ) As Integer | |
Parameters
- areas
- An array of source names, as returned by EventAreaBrowser.GetQualifiedSourceName
- errors
- Array of HRESULTS indicating the success of placing all conditions for the specified event source into the enabled state. The errors correspond to the sources passed into the method.
Requirements
Target Platforms: Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows 7, Windows Server 2008 family