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

sources
Array of source names, as returned by EventAreaBrowser.GetQualifiedSourceName
enabled
Array of BOOL indicating the current enable state of the corresponding source. TRUE if the source is enabled, FALSE if it is disabled. Note this value reflects the state as a result of the last call to EnableConditionBySource2 or DisableConditionBySource2. In other words, it does not reflect the enable state of the containing areas in its hierarchy.
effectivelyEnabled
Array of BOOL indicating the effective enable state of the corresponding source. TRUE if the source is enabled and all areas within the hierarchy of its containing areas are enabled. FALSE if the source is disabled or any area within the hierarchy of its containing areas is disabled.
errors
Array of HRESULTS indicating the success of retrieving the enable state of the source. The errors correspond to the sources passed into the method.Array of HRESULTS indicating the success of retrieving the enable state of the area. The errors correspond to the areas passed into the method.

Glossary Item Box

Returns the current enable state and the effective enable state for each source specified in sources.

Syntax

Visual Basic (Declaration) 
Public Function GetEnableStateBySource( _
   ByVal sources() As String, _
   ByRef enabled As Boolean(), _
   ByRef effectivelyEnabled As Boolean(), _
   ByRef errors As Integer() _
) As Integer
C# 
public int GetEnableStateBySource( 
   string[] sources,
   out bool[] enabled,
   out bool[] effectivelyEnabled,
   out int[] errors
)

Parameters

sources
Array of source names, as returned by EventAreaBrowser.GetQualifiedSourceName
enabled
Array of BOOL indicating the current enable state of the corresponding source. TRUE if the source is enabled, FALSE if it is disabled. Note this value reflects the state as a result of the last call to EnableConditionBySource2 or DisableConditionBySource2. In other words, it does not reflect the enable state of the containing areas in its hierarchy.
effectivelyEnabled
Array of BOOL indicating the effective enable state of the corresponding source. TRUE if the source is enabled and all areas within the hierarchy of its containing areas are enabled. FALSE if the source is disabled or any area within the hierarchy of its containing areas is disabled.
errors
Array of HRESULTS indicating the success of retrieving the enable state of the source. The errors correspond to the sources passed into the method.Array of HRESULTS indicating the success of retrieving the enable state of the area. 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.