User User User User Class

Definition

Provides access to the information about the current user.

public ref class User
public class User
type User = class
Public Class User
Inheritance
UserUserUserUser
Derived

Examples

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

Remarks

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.

Note

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.

Note

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.

Constructors

User() User() User() User()

Initializes a new instance of the User class.

Properties

CurrentPrincipal CurrentPrincipal CurrentPrincipal CurrentPrincipal

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

InternalPrincipal InternalPrincipal InternalPrincipal InternalPrincipal

Gets or sets the principal object representing the current user.

IsAuthenticated IsAuthenticated IsAuthenticated IsAuthenticated

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

Name Name Name Name

Gets the name of the current user.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeWithWindowsUser() InitializeWithWindowsUser() InitializeWithWindowsUser() InitializeWithWindowsUser()

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

IsInRole(BuiltInRole) IsInRole(BuiltInRole) IsInRole(BuiltInRole) IsInRole(BuiltInRole)

Determines whether the current user belongs to the specified role.

IsInRole(String) IsInRole(String) IsInRole(String) IsInRole(String)

Determines whether the current user belongs to the specified role.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also