User.CurrentPrincipal Property

Reference

Definition

Namespace:: Microsoft.VisualBasic.ApplicationServices

Assembly:: Microsoft.VisualBasic.dll

Assembly:: Microsoft.VisualBasic.Forms.dll

Source:: User.vb

Source:: User.vb

Source:: User.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property System::Security::Principal::IPrincipal ^ CurrentPrincipal { System::Security::Principal::IPrincipal ^ get(); void set(System::Security::Principal::IPrincipal ^ value); };

public System.Security.Principal.IPrincipal CurrentPrincipal { get; set; }

member this.CurrentPrincipal : System.Security.Principal.IPrincipal with get, set

Public Property CurrentPrincipal As IPrincipal

Property Value

IPrincipal

A IPrincipal value representing the security context.

Exceptions

SecurityException

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

Examples

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

Remarks

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

Applies to

Jaa