Connectivity Software User's Guide and Reference
GetUserRecordInfo Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Security.User.Extensions Namespace > IReadOnlyNameAndPasswordUserManager2Extension Class : GetUserRecordInfo Method
The user manager.

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

The security ID of the user.

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

When this method returns, contains the user record information if the user was found; otherwise, null.

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

Gets the user record information for the specified security ID.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function GetUserRecordInfo( _
   ByVal readOnlyNameAndPasswordUserManager2 As IReadOnlyNameAndPasswordUserManager2, _
   ByVal securityId As String, _
   ByRef userRecordInfo As UserRecordInfo _
) As Boolean
'Usage
 
Dim readOnlyNameAndPasswordUserManager2 As IReadOnlyNameAndPasswordUserManager2
Dim securityId As String
Dim userRecordInfo As UserRecordInfo
Dim value As Boolean
 
value = IReadOnlyNameAndPasswordUserManager2Extension.GetUserRecordInfo(readOnlyNameAndPasswordUserManager2, securityId, userRecordInfo)

Parameters

readOnlyNameAndPasswordUserManager2
The user manager.

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

securityId
The security ID of the user.

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

userRecordInfo
When this method returns, contains the user record information if the user was found; otherwise, null.

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

Return Value

true if the user was found and the information was retrieved 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

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