FindEventCondition Method

Attempts to find a specified event condition in the OPC server and for given event category, and returns information about it when found.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Function FindEventCondition( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal categoryId As Long, _
   ByVal conditionName As String, _
   ByRef conditionElement As AEConditionElement _
) As Boolean

'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim categoryId As Long
Dim conditionName As String
Dim conditionElement As AEConditionElement
Dim value As Boolean
 
value = IEasyAEClientExtension2.FindEventCondition(client, serverDescriptor, categoryId, conditionName, conditionElement)

[Extension()]
public static bool FindEventCondition( 
   IEasyAEClient client,
   ServerDescriptor serverDescriptor,
   long categoryId,
   string conditionName,
   out AEConditionElement conditionElement
)

[Extension()]
public:
static bool FindEventCondition( 
   IEasyAEClient^ client,
   ServerDescriptor^ serverDescriptor,
   int64 categoryId,
   String^ conditionName,
   [Out] AEConditionElement^ conditionElement
)

Parameters

client: The client object that will perform the operation.
serverDescriptor: The OPC server involved in the operation.
categoryId: Event category whose conditions should be searched.
conditionName: Event condition name to be found.
conditionElement: Information about the event condition, if found.

Return Value

Returns 'true' if the event condition has been found, 'false' otherwise.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.OperationModel.OpcException

The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyAEClientExtension2 Class
IEasyAEClientExtension2 Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.