FindSecurityGroupElement Method

Finds a published security group by its Id in an optionally specified security group folder.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Function FindSecurityGroupElement( _
   ByVal securityGroupId As String, _
   ByVal securityGroupFolderPath As IReadOnlyList(Of String) _
) As SecurityGroupElement

'Usage
 
Dim instance As IUAReadOnlyPubSubSecurityKeyService
Dim securityGroupId As String
Dim securityGroupFolderPath As IReadOnlyList(Of String)
Dim value As SecurityGroupElement
 
value = instance.FindSecurityGroupElement(securityGroupId, securityGroupFolderPath)

[CanBeNull()]
SecurityGroupElement FindSecurityGroupElement( 
   string securityGroupId,
   IReadOnlyList<string> securityGroupFolderPath
)

[CanBeNull()]
SecurityGroupElement^ FindSecurityGroupElement( 
   String^ securityGroupId,
   IReadOnlyList<String^>^ securityGroupFolderPath
)

Parameters

securityGroupId

The Id of the security group.

The value of this parameter cannot be null (Nothing in Visual Basic).

securityGroupFolderPath

An optional path to the folder that contains the security group.

The value of this parameter can be null (Nothing in Visual Basic).

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Return Value

Returns a security group element representing the security group, or null when the specified security group does not exist.

This method can return null (Nothing in Visual Basic).

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.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA 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.
OpcLabs.EasyOpc.UA.OperationModel.UALogicalException	There is a logical error in the OPC UA operation. 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.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA 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.

OpcLabs.EasyOpc.UA.OperationModel.UALogicalException

There is a logical error in the OPC UA operation.

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.

Remarks

When the securityGroupFolderPath is not null, the search is performed in the specified security group folder only. When the securityGroupFolderPath is null, the whole security group folder structure is searched. Note that the security group Id must be unique across all security group folders in the SKS.

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

IUAReadOnlyPubSubSecurityKeyService Interface
IUAReadOnlyPubSubSecurityKeyService Members

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.