FromSecurityRoleId Method

Creates an OPC UA security role from a security role ID string.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Public Shared Function FromSecurityRoleId( _
   ByVal securityRoleId As String _
) As UASecurityRole

'Usage
 
Dim securityRoleId As String
Dim value As UASecurityRole
 
value = UASecurityRole.FromSecurityRoleId(securityRoleId)

[JetBrains.Annotations.CanBeNull()]
public static UASecurityRole FromSecurityRoleId( 
   string securityRoleId
)

[JetBrains.Annotations.CanBeNull()]
public:
static UASecurityRole^ FromSecurityRoleId( 
   String^ securityRoleId
)

Parameters

securityRoleId: The security role ID string, which should start with the "opcua:" prefix.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

A new UASecurityRole instance if the string starts with the expected prefix; otherwise, null.

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

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

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