Connectivity Software User's Guide and Reference
VerifyUserNameUserIdentityToken Method



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

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

The username user identity token to verify.

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

When this method returns, contains the verified user identity if verification was successful; otherwise, null.

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

Verifies a username user identity token and returns the verification outcome.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function VerifyUserNameUserIdentityToken( _
   ByVal readOnlyNameAndPasswordUserManager As IReadOnlyNameAndPasswordUserManager, _
   ByVal userNameUserIdentityToken As UserNameUserIdentityToken, _
   ByRef userIdentity As IUserIdentity _
) As UserVerificationOutcome
'Usage
 
Dim readOnlyNameAndPasswordUserManager As IReadOnlyNameAndPasswordUserManager
Dim userNameUserIdentityToken As UserNameUserIdentityToken
Dim userIdentity As IUserIdentity
Dim value As UserVerificationOutcome
 
value = IReadOnlyNameAndPasswordUserManagerExtension.VerifyUserNameUserIdentityToken(readOnlyNameAndPasswordUserManager, userNameUserIdentityToken, userIdentity)

Parameters

readOnlyNameAndPasswordUserManager
The user manager.

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

userNameUserIdentityToken
The username user identity token to verify.

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

userIdentity
When this method returns, contains the verified user identity if verification was successful; otherwise, null.

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

Return Value

The outcome of the user verification.
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.

An invoked method is not supported at all, or is not supported with the parameters used to create the object.
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