QuickOPC User's Guide and Reference
FindEventCategory Method



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.AlarmsAndEvents.Extensions Namespace > IEasyAEClientExtension2 Class : FindEventCategory Method
The client object that will perform the operation.
The OPC server involved in the operation.
Event category ID to be found.
Information about the event category, if found.
Attempts to find a specified event category in the OPC server, and returns information about it when found.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function FindEventCategory( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal categoryId As Long, _
   ByRef categoryElement As AECategoryElement _
) As Boolean
'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim categoryId As Long
Dim categoryElement As AECategoryElement
Dim value As Boolean
 
value = IEasyAEClientExtension2.FindEventCategory(client, serverDescriptor, categoryId, categoryElement)

Parameters

client
The client object that will perform the operation.
serverDescriptor
The OPC server involved in the operation.
categoryId
Event category ID to be found.
categoryElement
Information about the event category, if found.

Return Value

Returns 'true' if the event category has been found, 'false' otherwise.
Exceptions
ExceptionDescription
The OPC "Classic" (or OPC XML-DA) operation has failed.
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
The value of an argument is outside the allowable range of values as defined by the invoked method.
Requirements

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

See Also

Reference

IEasyAEClientExtension2 Class
IEasyAEClientExtension2 Members