Connectivity Software User's Guide and Reference
RemoveSecurityRoleIds Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Security.User.Extensions Namespace > INameAndPasswordUserManagerExtension Class : RemoveSecurityRoleIds Method
The user manager.

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

The username of the user.

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

The security role IDs to remove.

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

Removes multiple security role IDs from a user.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function RemoveSecurityRoleIds( _
   ByVal nameAndPasswordUserManager As INameAndPasswordUserManager, _
   ByVal userName As String, _
   ByVal securityRoleIds As IEnumerable(Of String) _
) As Boolean
'Usage
 
Dim nameAndPasswordUserManager As INameAndPasswordUserManager
Dim userName As String
Dim securityRoleIds As IEnumerable(Of String)
Dim value As Boolean
 
value = INameAndPasswordUserManagerExtension.RemoveSecurityRoleIds(nameAndPasswordUserManager, userName, securityRoleIds)

Parameters

nameAndPasswordUserManager
The user manager.

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

userName
The username of the user.

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

securityRoleIds
The security role IDs to remove.

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

true if all security role IDs were removed successfully; 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.

Remarks

If the method returns false, the operation might have been partially successful.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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