Share via

SharePoint Provider::GetRolesFromUser

  • Article

The GetRolesFromUser method returns information about the collection of site groups of which the specified user is a member.

Arguments

Input Arguments Required Description

<target>

Yes

SharePoint site.

<userLoginName>

Yes

A string that contains the user's login name.

Remarks

No remarks.

Sample Code

Comments

An array of role info in the format shown below.

Example XML Request

<request> 
    <procedure> 
 
        <execute namespace="WSS Provider" procedure="GetRolesFromUser" 
 
                   impersonate="1"> 
 
            <executeData> 
 
                <target>https://raven003/sites/test</target> 
 
                <userLoginName>raven00\TestRoleGuy</userLoginName> 
 
            </executeData> 
 
        </execute> 
 
    </procedure> 
 
</request>

Example XML Response

<executeData> 
    <target>https://raven003/sites/test</target> 
 
    <userLoginName>raven00\TestRoleGuy</userLoginName> 
 
    <Roles> 
 
        <Role ID="1073741834" Name="TestRole" Description="A test role" Type="0" /> 
 
    </Roles> 
 
</executeData>

Typical C# Usage

No typical C# usage.

Applies To

Windows SharePoint Services Provider API for

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

SharePoint Provider::GetUsersFromRole
SharePoint Provider::RemoveUsersFromRole