Connectivity Software User's Guide and Reference
GetSecurityRoleIdList Method (IReadOnlyNameAndPasswordUserManager)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Security.User Namespace > IReadOnlyNameAndPasswordUserManager Interface : GetSecurityRoleIdList Method
The security ID of the user.

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

When this method returns, contains the list of security role IDs if the user was found; otherwise, null.

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

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

Gets the security role IDs for the user with the specified security ID.
Syntax
'Declaration
 
Function GetSecurityRoleIdList( _
   ByVal securityId As String, _
   ByRef securityRoleIds As IReadOnlyList(Of String) _
) As Boolean
'Usage
 
Dim instance As IReadOnlyNameAndPasswordUserManager
Dim securityId As String
Dim securityRoleIds As IReadOnlyList(Of String)
Dim value As Boolean
 
value = instance.GetSecurityRoleIdList(securityId, securityRoleIds)

Parameters

securityId
The security ID of the user.

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

securityRoleIds
When this method returns, contains the list of security role IDs if the user was found; otherwise, null.

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

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

Return Value

true if the user was found; otherwise, false.
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.

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