ListAllSecurityGroupIds Method

Gets Ids of all security groups in the PubSub security key service.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Shared Function ListAllSecurityGroupIds( _
   ByVal readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService _
) As StringCollection

'Usage
 
Dim readOnlyPubSubSecurityKeyService As IUAReadOnlyPubSubSecurityKeyService
Dim value As StringCollection
 
value = IUAReadOnlyPubSubSecurityKeyServiceExtension.ListAllSecurityGroupIds(readOnlyPubSubSecurityKeyService)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public static StringCollection ListAllSecurityGroupIds( 
   IUAReadOnlyPubSubSecurityKeyService readOnlyPubSubSecurityKeyService
)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static StringCollection^ ListAllSecurityGroupIds( 
   IUAReadOnlyPubSubSecurityKeyService^ readOnlyPubSubSecurityKeyService
)

Parameters

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

Return Value

Returns a collection of security group Ids.

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.

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.

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

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