SPUtility.ResolvePrincipal Method (SPWebApplication, Nullable<SPUrlZone>, String, SPPrincipalType, SPPrincipalSource, Boolean)

Resolves principal information into an SPPrincipalInfo object.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)> _
Public Shared Function ResolvePrincipal ( _
    webApp As SPWebApplication, _
    urlZone As Nullable(Of SPUrlZone), _
    input As String, _
    scopes As SPPrincipalType, _
    sources As SPPrincipalSource, _
    inputIsEmailOnly As Boolean _
) As SPPrincipalInfo
'Usage
Dim webApp As SPWebApplication
Dim urlZone As Nullable(Of SPUrlZone)
Dim input As String
Dim scopes As SPPrincipalType
Dim sources As SPPrincipalSource
Dim inputIsEmailOnly As Boolean
Dim returnValue As SPPrincipalInfo

returnValue = SPUtility.ResolvePrincipal(webApp, _
    urlZone, input, scopes, sources, inputIsEmailOnly)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.PerSpec)]
public static SPPrincipalInfo ResolvePrincipal(
    SPWebApplication webApp,
    Nullable<SPUrlZone> urlZone,
    string input,
    SPPrincipalType scopes,
    SPPrincipalSource sources,
    bool inputIsEmailOnly
)

Parameters

• webApp
  Type: Microsoft.SharePoint.Administration.SPWebApplication

  A SharePoint Services application that is installed on the farm.

• urlZone
  Type: System.Nullable<SPUrlZone>

  The zone from which the request was received by SharePoint Services, or null.

• input
  Type: System.String

  The display name, email address, or login name that identifies the principal.

• scopes
  Type: Microsoft.SharePoint.Utilities.SPPrincipalType

  An SPPrincipalType mask that indicates the type of principal to be resolved.

• sources
  Type: Microsoft.SharePoint.Utilities.SPPrincipalSource

  An SPPrincipalSource mask that indicates the source to be used in the resolution process.

• inputIsEmailOnly
  Type: System.Boolean

  A Boolean value that indicates the fields to be matched during the search for the principal. A value of true indicates that the match can be made by using only the e-mail address of a principal. A value of false indicates that a match can be made by using the any one of the display name, the e-mail address, or the login name of a principal.

Return Value

Type: Microsoft.SharePoint.Utilities.SPPrincipalInfo
An SPPrincipalInfo object that represents principal information.

See Also

Reference

SPUtility Class

SPUtility Members

ResolvePrincipal Overload

Microsoft.SharePoint.Utilities Namespace