User.CurrentPrincipal Property

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

A IPrincipal value representing the security context.

Exceptions

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

Applies to

See also

• IPrincipal
• Objects (Visual Basic)