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

source
A source name, as returned by the EventAreaBrower.GetQualifiedSourceName method. The state of the condition instance associated with this source is returned.
conditionName
A condition name, as returned by the QueryConditionNames method. The state of this condition is returned.
attributeIDs
The array of Attribute IDs indicating which event attributes should be returned in the OPCCONDITIONSTATE structure.
conditionState
Object to where the OPCCONDITIONSTATE should be returned.

Glossary Item Box

Returns the current state information for the condition instance corresponding to the szSource and szConditionName. The OPCCONDITIONSTATE structure is defined below. See section 2.4 for a discussion of conditions and their states.
Some servers may not maintain sufficient condition state information to fully implement this method. In this case, the server should return E_NOTIMPL. If a server chooses to implement this method, it must return valid information for every member of OPCCONDITIONSTATE.

Syntax

Visual Basic (Declaration) 
Public Function GetConditionState( _
   ByVal source As String, _
   ByVal conditionName As String, _
   ByVal attributeIDs() As Integer, _
   ByRef conditionState As AEConditionState _
) As Integer
C# 
public int GetConditionState( 
   string source,
   string conditionName,
   int[] attributeIDs,
   out AEConditionState conditionState
)

Parameters

source
A source name, as returned by the EventAreaBrower.GetQualifiedSourceName method. The state of the condition instance associated with this source is returned.
conditionName
A condition name, as returned by the QueryConditionNames method. The state of this condition is returned.
attributeIDs
The array of Attribute IDs indicating which event attributes should be returned in the OPCCONDITIONSTATE structure.
conditionState
Object to where the OPCCONDITIONSTATE should be returned.

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.