OPCAE.NET Reference Manual
GetEnableStateByArea Method
See Also  Send Feedback
OPCAE.NET Namespace > OpcEventServer Class : GetEnableStateByArea Method

Areas
An array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName
Enabled
Array of BOOL indicating the current enable state of the corresponding area.
TRUE if the area is enabled, FALSE if it is disabled. Note this value reflects the state as a result of the last call to EnableConditionByArea2 or DisableConditionByArea2. 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 area.
TRUE if the area is enabled and all areas within the hierarchy of its containing areas are enabled.
FALSE if the area 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 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 area specified in Areas.
This is an optional function that's not supported by all servers.

Syntax

Visual Basic (Declaration) 
Public Function GetEnableStateByArea( _
   ByVal Areas() As String, _
   ByRef Enabled As Boolean(), _
   ByRef EffectivelyEnabled As Boolean(), _
   ByRef Errors As Integer() _
) As Integer
C# 
public int GetEnableStateByArea( 
   string[] Areas,
   out bool[] Enabled,
   out bool[] EffectivelyEnabled,
   out int[] Errors
)

Parameters

Areas
An array of area names, as returned by EventAreaBrowser.GetQualifiedAreaName
Enabled
Array of BOOL indicating the current enable state of the corresponding area.
TRUE if the area is enabled, FALSE if it is disabled. Note this value reflects the state as a result of the last call to EnableConditionByArea2 or DisableConditionByArea2. 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 area.
TRUE if the area is enabled and all areas within the hierarchy of its containing areas are enabled.
FALSE if the area 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 area. The errors correspond to the areas passed into the method.

Return Value

HRESULTS error/success code.

Requirements

Target Platforms: Windows 7/8/10, Windows Server 2003/2008/2012/2016, .NET 4.x

See Also

© 2002-2018 Advosol Inc. All Rights Reserved.