Share via

SharePoint Provider::GetGroupsFromRole

  • Article

Returns information about the collection of cross-site groups assigned to the specified site group.

Arguments

Input Arguments Required Description

<target>

Yes

SharePoint site.

<roleName>

Yes

A string that contains the name of the site group.
Output Arguments Description

True

If the method succeeds.

Remarks

No remarks.

Sample Code

Comments

An array of group info in the format shown below.

Example XML Request

<request> 
    <procedure> 
 
        <execute namespace="WSS Provider" procedure="GetGroupCollectionFromRole" 
 
                   impersonate="1"> 
 
            <executeData> 
 
                <target>https://raven003/sites/test</target> 
 
                <roleName>TestRole</roleName> 
 
            </executeData> 
 
        </execute> 
 
    </procedure> 
 
</request>

Example XML Response

<executeData> 
    <target>https://raven003/sites/test</target> 
 
    <roleName>TestRole</roleName> 
 
    <Groups> 
 
        <Group ID="7" Name="TestGroup" Description="A test group"  
 
            OwnerID="1" OwnerIsUser="True" /> 
 
    </Groups> 
 
</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::RemoveGroupFromRole