1 out of 1 rated this helpful Rate this topic

SPWeb.EnsureUser Method

SharePoint 2010

Windows SharePoint Services 3

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)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

Copy

[ClientCallableAttribute]
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.

Reference

SPWeb Class

SPWeb Members

Microsoft.SharePoint Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(2000 characters remaining)

Community Content Add

FAQ

Error Thrown

Make sure that any login name you pass in actually exists in one of your authentication providers. If not you'll see an SPException thrown with the message "The specified user {0} could not be found.". Where {0} is the name of your user.

History

4/18/2011
Mark Zacharias