Connectivity Software User's Guide and Reference
SetEnabled Method (INameAndPasswordUserManager)



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

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

Whether the user should be enabled.
Sets whether the user with the specified security ID is enabled.
Syntax
'Declaration
 
Function SetEnabled( _
   ByVal securityId As String, _
   ByVal enabled As Boolean _
) As Boolean
'Usage
 
Dim instance As INameAndPasswordUserManager
Dim securityId As String
Dim enabled As Boolean
Dim value As Boolean
 
value = instance.SetEnabled(securityId, enabled)
bool SetEnabled( 
   string securityId,
   bool enabled
)

Parameters

securityId
The security ID of the user.

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

enabled
Whether the user should be enabled.

Return Value

true if the enabled status was set 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.

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