User Class

 

Provides access to the information about the current user.

Namespace:   Microsoft.VisualBasic.ApplicationServices
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

System.Object
  Microsoft.VisualBasic.ApplicationServices.User
    Microsoft.VisualBasic.ApplicationServices.WebUser

<HostProtectionAttribute(SecurityAction.LinkDemand, Resources := HostProtectionResource.ExternalProcessMgmt)>
Public Class User

NameDescription
System_CAPS_pubmethodUser()

Initializes a new instance of the User class.

NameDescription
System_CAPS_pubpropertyCurrentPrincipal

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

System_CAPS_protpropertyInternalPrincipal

Gets or sets the principal object representing the current user.

System_CAPS_pubpropertyIsAuthenticated

Gets a value that indicates whether the user has been authenticated.

System_CAPS_pubpropertyName

Gets the name of the current user.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeWithWindowsUser()

Sets the thread's current principal to the Windows user that started the application.

System_CAPS_pubmethodIsInRole(BuiltInRole)

Determines whether the current user belongs to the specified role.

System_CAPS_pubmethodIsInRole(String)

Determines whether the current user belongs to the specified role.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The properties and methods exposed by the My.User object provide access to the information about the current user. The meaning of "current user" differs slightly between Windows and Web applications. In a Windows application, the current user is the user who runs the application. In a Web application, the current user is the user who accesses the application.

The My.User property also provides access to the IPrincipal for the current user. A principal object represents the user's security context, including that user's identity and any roles to which the user belongs.

For Windows applications, this property provides the same functionality as the CurrentPrincipal property. For Web applications, this property provides the same functionality as the User property of the object returned by the Current property.

System_CAPS_noteNote

For Windows applications, only projects built on the Windows Application template initialize the My.User object by default. In all other Windows project types, you must initialize the My.User object by calling the InitializeWithWindowsUser method explicitly or by assigning a value to CurrentPrincipal.

System_CAPS_noteNote

The My.User object cannot report information about the current Windows user when run under Windows 95 and Windows 98 because those operating systems do not support the concept of a logged-on user. You must implement custom authentication to use the My.User object on those operating systems.

This example checks if the application is using Windows or custom authentication, and uses that information to parse the 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
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: