SPRoleCollection.GetSpecialRole-Methode
HINWEIS: Diese API ist veraltet.
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, die GetCollection -Methode eine durch dieses Typs angegebene Systemrolle zurückgegeben und wird für die Abwärtskompatibilität beibehalten.)
Namespace: Microsoft.SharePoint
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use the SPRoleDefinitionCollection class instead")> _
Public Function GetSpecialRole ( _
roleType As SPRoleType _
) As SPRole
'Usage
Dim instance As SPRoleCollection
Dim roleType As SPRoleType
Dim returnValue As SPRole
returnValue = instance.GetSpecialRole(roleType)
[ObsoleteAttribute("Use the SPRoleDefinitionCollection class instead")]
public SPRole GetSpecialRole(
SPRoleType roleType
)
Parameter
roleType
Typ: Microsoft.SharePoint.SPRoleTypeEin SPRoleType -Wert, der den Typ angibt.
Rückgabewert
Typ: Microsoft.SharePoint.SPRole
Ein SPRole -Objekt, das die Rolle darstellt.
Beispiele
Im folgenden Codebeispiel wird die GetSpecialRole -Methode zum Hinzufügen eines angegebenen Benutzers zur Rolle Reader auf der aktuellen Website verwendet.
Das Beispiel setzt das Vorhandensein einer ASPX-Seite, die ein Label-Steuerelement enthält.
Dim site As SPWeb = SPContext.Current.Web
Dim roles As SPRoleCollection = site.Roles
Dim role As SPRole = roles.GetSpecialRole(SPRoleType.Reader)
role.AddUser("User_Name", "E-mail_Address", "User_Display_Name",
"Notes")
SPWeb oWebsite = SPContext.Current.Web;
SPRoleCollection collRoles = oWebsite.Roles;
SPRole oRole = collRoles.GetSpecialRole(SPRoleType.Reader);
oRole.AddUser("User_Name", "E-mail_Address", "User_Display_Name",
"Notes");