SPRoleCollection.GetSpecialRole - Méthode
Remarque : cette API est désormais obsolète.
Obsolète. Utilisez à la place, les nouvelles classes SPRoleDefinition et SPRoleAssignment pour définir des rôles et de leur affecter des utilisateurs. Pour plus d'informations, consultez Changes in the Authorization Object Model. (Dans Windows SharePoint Services 2.0, la méthode GetCollection a renvoyé un rôle système spécifié par son type et est conservée pour la compatibilité ascendante.)
Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
<ObsoleteAttribute("Use the SPRoleDefinitionCollection class instead")> _
Public Function GetSpecialRole ( _
roleType As SPRoleType _
) As SPRole
'Utilisation
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
)
Paramètres
roleType
Type : Microsoft.SharePoint.SPRoleTypeUne valeur SPRoleType qui spécifie le type.
Valeur renvoyée
Type : Microsoft.SharePoint.SPRole
Objet SPRole qui représente le rôle.
Exemples
L'exemple de code suivant utilise la méthode GetSpecialRole pour ajouter un utilisateur spécifié au rôle Reader sur le site actuel.
L'exemple suivant suppose l'existence d'une page .aspx qui contient un contrôle Label.
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");