OPC Studio User's Guide and Reference
ListSecurityGroupFolderNames Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.SecurityKeyService Namespace > IUAReadOnlyPubSubSecurityKeyService Interface : ListSecurityGroupFolderNames Method
A path to the security group folder.

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).

Gets the names of security group folders in the SKS.
Syntax
'Declaration
 
<NotNullAttribute()>
Function ListSecurityGroupFolderNames( _
   ByVal securityGroupFolderPath As IReadOnlyList(Of String) _
) As StringCollection
'Usage
 
Dim instance As IUAReadOnlyPubSubSecurityKeyService
Dim securityGroupFolderPath As IReadOnlyList(Of String)
Dim value As StringCollection
 
value = instance.ListSecurityGroupFolderNames(securityGroupFolderPath)
[NotNull()]
StringCollection ListSecurityGroupFolderNames( 
   IReadOnlyList<string> securityGroupFolderPath
)
[NotNull()]
StringCollection^ ListSecurityGroupFolderNames( 
   IReadOnlyList<String^>^ securityGroupFolderPath
) 

Parameters

securityGroupFolderPath
A path to the security group folder.

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).

Return Value

Returns a collection of security group folder Ids.

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

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

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.

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.

Requirements

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

See Also