Connectivity Software User's Guide and Reference
IsKnown Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Security.User.Extensions Namespace > IReadOnlyNameAndPasswordUserManagerExtension Class : IsKnown Method
The user manager.

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

The username to check.

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

Determines whether a user with the specified username exists in the user manager.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function IsKnown( _
   ByVal readOnlyNameAndPasswordUserManager As IReadOnlyNameAndPasswordUserManager, _
   ByVal userName As String _
) As Boolean
'Usage
 
Dim readOnlyNameAndPasswordUserManager As IReadOnlyNameAndPasswordUserManager
Dim userName As String
Dim value As Boolean
 
value = IReadOnlyNameAndPasswordUserManagerExtension.IsKnown(readOnlyNameAndPasswordUserManager, userName)

Parameters

readOnlyNameAndPasswordUserManager
The user manager.

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

userName
The username to check.

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

Return Value

true if the user exists; 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

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