SPRole class

NOTE: This API is now obsolete.

Use em vez disso, as novas classes SPRoleDefinition e SPRoleAssignment para definir funções e atribuir usuários a elas. Para obter mais informações, consulte Changes in the Authorization Object Model. (Em Windows SharePoint Services 2,0, o SPRole representado um grupo de sites e é mantido para compatibilidade com versões anteriores.)

Inheritance hierarchy

System.Object
  Microsoft.SharePoint.SPMember
    Microsoft.SharePoint.SPRole

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

Syntax

'Declaração
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Class SPRole _
    Inherits SPMember
'Uso
Dim instance As SPRole

[ObsoleteAttribute("Use the SPRoleDefinition class instead")]
public class SPRole : SPMember

Comentários

Use a propriedade Roles da classe SPUser, SPGroupou SPWeb para retornar um objeto SPRoleCollection que representa a coleção de funções ou definições de função para um usuário, grupo ou site da Web. Use um indexador para retornar uma única função da coleção. Por exemplo, se a coleção for atribuída a uma variável chamada collRoles, use collRoles[index] em C# ou deindexde collRoles() no Visual Basic, onde index é o número de índice da função na coleção ou o nome de exibição da função.

Cada função ou definição de função tem uma identificação de membro exclusivo (propriedadeID ), tem as permissões associadas a essa associação e pode ser representada por um objeto SPMember .

O exemplo a seguir atribui uma função a um objeto SPMember .

Dim myMember As SPMember = site.Roles("Role_Name")

SPMember oMember = oWebsite.Roles["Role_Name"];

Para executar tarefas administrativas que afetem as configurações para todos os aplicativos Web no farm de servidores, um usuário deve ser um membro do grupo administrador do SharePoint.

As funções Administrator e Guest não podem ser modificadas ou excluídas.

Para obter informações gerais sobre segurança e as funções, consulte Security, Users, and Groups in Windows SharePoint Services.

Para obter informações sobre as funções padrão que estão disponíveis em SharePoint Foundation, consulte a enumeração SPRoleType .

Examples

O exemplo de código a seguir remove um usuário específico de uma função em todos os subsites em um site.

Dim site As SPWeb = 
    SPContext.Current.Site.AllWebs("Site_Name")
Dim subSites As SPWebCollection = site.Webs
Dim user As SPUser = site.Users("User_Name")
Dim subSite As SPWeb

For Each subSite In  subSites

    Dim role As SPRole = subSite.Roles("Role_Name")

    role.RemoveUser(user)

Next subSite

using(SPWeb oParentWebsite = SPContext.Current.Site.AllWebs["Site_Name"])
{
    SPWebCollection collWebsites = oParentWebsite.Webs;
    SPUser oUser = oParentWebsite.Users["User_Name"];

    foreach (SPWeb oWebsite in collWebsites)
    {
        SPRole oRole = oWebsite.Roles["Role_Name"];
        oRole.RemoveUser(oUser);

        oWebsite.Dispose();
    }
}

Thread safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Ver também

Referência

SPRole members

Microsoft.SharePoint namespace