SPWeb.EnsureUser method

Checks whether the specified logon name belongs to a valid user of the website, and if the logon name does not already exist, adds it to the website.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Function EnsureUser ( _
    logonName As String _
) As SPUser
'Usage
Dim instance As SPWeb
Dim logonName As String
Dim returnValue As SPUser

returnValue = instance.EnsureUser(logonName)

public SPUser EnsureUser(
    string logonName
)

Parameters

• logonName
  Type: System.String

  The logon name (Domain\User_Alias) of the user.

Return value

Type: Microsoft.SharePoint.SPUser
A user with the specified logon name.

Exceptions

Exception	Condition
SPException	The user with the specified logonName cannot be found in Active Directory.

Remarks

The current user must have the BrowseUserInfo rights to view the users of the website.

See also

Reference

SPWeb class

SPWeb members

Microsoft.SharePoint namespace