1 out of 4 rated this helpful - Rate this topic

SPWeb.EnsureUser Method

Windows SharePoint Services 3

SharePoint 2010

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

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

Syntax

Copy

public SPUser EnsureUser (
	string loginName
)

Parameters

loginName: A string that contains the login name.

Return Value

An SPUser object that represents the user.

Reference

SPWeb Class
SPWeb Members
Microsoft.SharePoint Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Requires that the current user is a Site Admin and that the authentication method is AD

Here's the reflected code for the method:

publicSPUserEnsureUser(string loginName)
{
    if ((this.CurrentUser == null) || !this.CurrentUser.IsSiteAdmin)
    {
        SPGlobal.HandleUnauthorizedAccessException(newUnauthorizedAccessException());
    }
    boolisADAccountCreationMode = this.IsADAccountCreationMode;
    SPPrincipalInfoinfo = SPUtility.ResolvePrincipalInternal(this, null, null, loginName, SPPrincipalType.SecurityGroup | SPPrincipalType.User, SPPrincipalSource.All, null, false, true);
    if (info == null)
    {
        thrownewSPException(SPResource.GetString("UserCouldNotBeFound", newobject[] { loginName }));
    }
    if (info.PrincipalId < 0)
    {
        this.SiteUsers.Add(info.LoginName, info.Email, info.DisplayName, string.Empty);
    }
    returnthis.SiteUsers[info.LoginName];
}

History

12/17/2008
austegard