SafeGetUserName Method

Safely retrieves the username from the security principal's identity context.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.CanBeNullAttribute()>
Public Shared Function SafeGetUserName( _
   ByVal securityPrincipal As ISecurityPrincipal _
) As String

'Usage
 
Dim securityPrincipal As ISecurityPrincipal
Dim value As String
 
value = ISecurityPrincipalExtension.SafeGetUserName(securityPrincipal)

[Extension()]
[JetBrains.Annotations.CanBeNull()]
public static string SafeGetUserName( 
   ISecurityPrincipal securityPrincipal
)

[Extension()]
[JetBrains.Annotations.CanBeNull()]
public:
static String^ SafeGetUserName( 
   ISecurityPrincipal^ securityPrincipal
)

Parameters

securityPrincipal: The security principal from which to get the username.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

The username if the identity is a OpcLabs.BaseLib.Security.User.UserNameTokenUserIdentity; otherwise, null.

This method can return null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.

System.ArgumentNullException

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

Reference

ISecurityPrincipalExtension Class
ISecurityPrincipalExtension Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.