SPRole class

發行項
05/05/2015

NOTE: This API is now obsolete.

請改用新的SPRoleDefinition和SPRoleAssignment類別，來定義角色，並將使用者指派給它們。如需詳細資訊，請參閱Changes in the Authorization Object Model。(在Windows SharePoint Services 2.0， SPRole表示網站群組和維護回溯相容性。)

Inheritance hierarchy

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

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

Syntax

'宣告
<ObsoleteAttribute("Use the SPRoleDefinition class instead")> _
Public Class SPRole _
    Inherits SPMember
'用途
Dim instance As SPRole

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

備註

使用SPUser、 SPGroup或SPWeb類別的Roles屬性，傳回SPRoleCollection物件，表示角色或使用者、群組或網站的角色定義的集合。若要從集合傳回單一角色中使用索引子。例如，如果集合指派給一個名為collRoles變數中，使用在 C# 的collRoles[index]或 Visual Basic，其中index是可能的索引編號的集合中的角色的顯示名稱中的collRoles(index) 。

每個角色或角色定義具有唯一的成員識別碼 (ID屬性)、具有與該成員資格，相關聯的權限，可以由SPMember物件。

下列範例會將角色指派給SPMember物件。

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

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

若要執行任何會影響到伺服器陣列中的所有 Web 應用程式設定的管理工作，使用者必須是 SharePoint 系統管理員群組的成員。

Administrator和Guest角色不能修改或刪除。

如需有關角色和安全性的一般資訊，請參閱Security, Users, and Groups in Windows SharePoint Services。

在SharePoint Foundation中可用的預設角色的相關資訊，請參閱SPRoleType列舉型別。

Examples

下列程式碼範例會將指定的使用者移除在 [網站] 下方的所有子網站中的角色。

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

注意事項
某些物件實作IDisposable介面，並且您必須避免之後不再需要保留這些物件在記憶體中。良好的程式碼撰寫方式的相關資訊，請參閱Disposing Objects。