This topic has not yet been rated - Rate this topic

User.CurrentPrincipal Property

Gets or sets the current principal (for role-based security).

Namespace:  Microsoft.VisualBasic.ApplicationServices
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)
public IPrincipal CurrentPrincipal { get; set; }

Property Value

Type: System.Security.Principal.IPrincipal
A IPrincipal value representing the security context.
ExceptionCondition
SecurityException

The caller does not have the permission required to set the principal.

You can set the My.User.CurrentPrincipal property to an object that implements the IPrincipal interface to enable custom authentication.

In most project types, this property gets and sets the thread's current principal. In an ASP.NET application, this property gets and sets the security information for the current HTTP request's user identity.

This is an advanced member; it does not show in IntelliSense unless you click the All tab.

Availability by Project Type

Project type

Available

Windows Application

Yes

Class Library

Yes

Console Application

Yes

Windows Control Library

Yes

Web Control Library

Yes

Windows Service

Yes

Web Site

Yes

This example checks if the application is using Windows or custom authentication, and uses that information to parse My.User.Name property.

Function GetUserName() As String 
    If TypeOf My.User.CurrentPrincipal Is 
      Security.Principal.WindowsPrincipal Then 
        ' The application is using Windows authentication. 
        ' The name format is DOMAIN\USERNAME. 
        Dim parts() As String = Split(My.User.Name, "\")
        Dim username As String = parts(1)
        Return username
    Else 
        ' The application is using custom authentication. 
        Return My.User.Name
    End If 
End Function

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.