BrowseSecurityGroups Method

Gets the elements for security groups in the specified security group folder, and possibly its subfolders (recursively).

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function BrowseSecurityGroups( _
   ByVal readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService, _
   ByVal securityGroupFolderPath As IReadOnlyList(Of String), _
   ByVal recursive As Boolean _
) As KeyedCollection(Of String,SecurityGroupElement)

'Usage
 
Dim readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService
Dim securityGroupFolderPath As IReadOnlyList(Of String)
Dim recursive As Boolean
Dim value As KeyedCollection(Of String,SecurityGroupElement)
 
value = IUAReadOnlyPubSubSecurityKeyServiceExtension.BrowseSecurityGroups(readOnlyPubSubSecurityKeyService, securityGroupFolderPath, recursive)

[Extension()]
[NotNull()]
public static KeyedCollection<string,SecurityGroupElement> BrowseSecurityGroups( 
   IUAReadOnlyPubSubSecurityKeyService readOnlyPubSubSecurityKeyService,
   IReadOnlyList<string> securityGroupFolderPath,
   bool recursive
)

[Extension()]
[NotNull()]
public:
static KeyedCollection<String^,SecurityGroupElement^>^ BrowseSecurityGroups( 
   IUAReadOnlyPubSubSecurityKeyService^ readOnlyPubSubSecurityKeyService,
   IReadOnlyList<String^>^ securityGroupFolderPath,
   bool recursive
)

Parameters

readOnlyPubSubSecurityKeyService

OPC UA PubSub security key service (read-only).

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

securityGroupFolderPath

A path to the folder that contains the security group.

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

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

recursive

Determines whether the security groups will be taken from the subfolders as well, recursively.

Return Value

Returns a collection of security group elements, keyed by the security group Id.

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never 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

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

IUAReadOnlyPubSubSecurityKeyServiceExtension Class
IUAReadOnlyPubSubSecurityKeyServiceExtension Members

Documentation Home, Send Documentation Feedback. Technical Support