Get Method (UASecurityRoles)

Gets a security role by its role ID.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function Get( _
   ByVal roleId As UANodeId _
) As UASecurityRole

'Usage
 
Dim roleId As UANodeId
Dim value As UASecurityRole
 
value = UASecurityRoles.Get(roleId)

[JetBrains.Annotations.NotNull()]
public static UASecurityRole Get( 
   UANodeId roleId
)

[JetBrains.Annotations.NotNull()]
public:
static UASecurityRole^ Get( 
   UANodeId^ roleId
)

Parameters

roleId

The node ID of the security role to get.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.UANodeId Constructor(String) constructor instead.

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

Return Value

The security role.

Because UASecurityRole has an implicit conversion to System.String, you can simply use the returned UASecurityRole in any place where System.String is expected as input, and the corresponding string (security ID) will be constructed automatically from the security role. When the implicit conversion operators are not supported (such as with Python.NET), you can use the SecurityId property instead.

Because UASecurityRole has an implicit conversion to OpcLabs.EasyOpc.UA.AddressSpace.UANodeId, you can simply use the returned UASecurityRole in any place where OpcLabs.EasyOpc.UA.AddressSpace.UANodeId is expected as input, and the node ID (OPC UA role ID) will be constructed automatically from the security role. When the implicit conversion operators are not supported (such as with Python.NET), you can use the ToUANodeId static method instead.

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

Exceptions

Exception Description

System.Collections.Generic.KeyNotFoundException Thrown when the security role with the specified ID is not found.

Exception	Description
System.Collections.Generic.KeyNotFoundException	Thrown when the security role with the specified ID is not found.
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.

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.

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

UASecurityRoles Class
UASecurityRoles 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.