Freigeben über


SPRole-Klasse

HINWEIS: Diese API ist veraltet.

Verwenden Sie stattdessen die neuen Klassen SPRoleDefinition und SPRoleAssignment , Definieren von Rollen und Benutzer zuweisen. Weitere Informationen finden Sie unter Changes in the Authorization Object Model. (In Windows SharePoint Services 2.0, SPRole eine Websitegruppe dargestellt und wird für die Abwärtskompatibilität beibehalten.)

Vererbungshierarchie

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

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

Syntax

'Declaration
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Class SPRole _
    Inherits SPMember
'Usage
Dim instance As SPRole
[ObsoleteAttribute("Use the SPRoleDefinition class instead")]
public class SPRole : SPMember

Hinweise

Verwenden Sie die Roles -Eigenschaft der SPUser, SPGroupoder SPWeb -Klasse, um ein SPRoleCollection -Objekt zurückzugeben, die die Auflistung von Rollen oder Rollendefinitionen für Benutzer, Gruppe oder Website darstellt. Verwenden Sie eine Indexerstellung, um eine einzelne Rolle aus der Auflistung zurückzugeben. Verwenden Sie beispielsweise, wenn die Auflistung einer Variablen mit dem Namen collRoleszugewiesen ist, collRoles[index] in c# oder collRoles(index) in Visual Basic index entweder die Indexnummer der Rolle in der Auflistung oder den Anzeigenamen der Rolle entspricht.

Jeder Rolle oder Rollendefinition verfügt über eine eindeutige Element-ID (ID -Eigenschaft), verfügt über die Berechtigungen, die Mitgliedschaft zugeordnet und kann durch ein SPMember -Objekt dargestellt werden.

Das folgende Beispiel weist eine Rolle zu einem SPMember -Objekt.

Dim myMember As SPMember = site.Roles("Role_Name")
SPMember oMember = oWebsite.Roles["Role_Name"];

Zum Ausführen von Verwaltungsaufgaben, die Einstellungen für alle Webanwendungen in der Serverfarm betreffen, muss ein Benutzer ein Mitglied der SharePoint-Administratorgruppe sein.

Die Rollen Administrator und Guest können nicht geändert oder gelöscht werden.

Allgemeine Informationen zu Rollen und Sicherheit finden Sie unter Security, Users, and Groups in Windows SharePoint Services.

Informationen zu den Standardrollen, die in SharePoint Foundationverfügbar sind, finden Sie unter der SPRoleType -Enumeration.

Beispiele

Im folgenden Codebeispiel wird entfernt einen angegebenen Benutzer aus einer Rolle in alle Unterwebsites unter einer Website.

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();
    }
}

Hinweis

Bestimmte Objekte, die IDisposable -Schnittstelle implementieren, und müssen Sie vermeiden, diese Objekte im Arbeitsspeicher beibehalten, wenn sie nicht mehr benötigt werden. Informationen zu bewährten Codierung finden Sie unter Disposing Objects.

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic) Member dieses Typs sind threadsicher. Die Threadsicherheit von Instanzmembern ist nicht gewährleistet.

Siehe auch

Referenz

SPRole-Member

Microsoft.SharePoint-Namespace