uaPLUS Reference
EnableConditionBySource2 Method
See Also Send Feedback

NSPlugin Namespace > AlarmEventServer Class : EnableConditionBySource2 Method

Visual Basic (Declaration)
C#

sources: 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 disabled state. The errors correspond to the sources passed into the method.

Places all conditions for the specified event sources into the disabled state. Therefore, the server will no longer generate condition-related events for these sources. 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). Disabling 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 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 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 null (Nothing) for the OUT parameter, errors.

Syntax

Visual Basic (Declaration)
Public Function EnableConditionBySource2( _ ByVal sources() As String, _ ByRef errors As Integer() _ ) As Integer

C#
public int EnableConditionBySource2( string[] sources, out int[] errors )

Parameters

sources: 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 disabled 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

Syntax

Parameters

Requirements

See Also

Reference