Roles.DeleteRole Method (String, Boolean)
.NET Framework 2.0
Removes a role from the data source.
Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)
Roles Members
System.Web.Security Namespace
Assembly: System.Web (in system.web.dll)
public static boolean DeleteRole ( String roleName, boolean throwOnPopulatedRole )
public static function DeleteRole ( roleName : String, throwOnPopulatedRole : boolean ) : boolean
Not applicable.
Parameters
- roleName
The name of the role to delete.
- throwOnPopulatedRole
If true, throws an exception if roleName has one or more members.
Return Value
true if roleName was deleted from the data source; otherwise; false.The DeleteRole method removes a role name from the data source. DeleteRole calls the DeleteRole method of the default role provider to remove the specified role from the data source.
If throwOnPopulatedRole is true, then an exception will be thrown and the role will not be deleted if the role identified by the roleName parameter has one or more members. If throwOnPopulatedRole is false, then the role will be deleted whether it is empty or not.
The following code example deletes a role from the data source. For an example of a Web.config file that enables role management, see Roles.
<%@ Page Language="C#" %> <%@ Import Namespace="System.Web.Security" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> string[] rolesArray; public void Page_Load(object sender, EventArgs args) { if (!IsPostBack) { // Bind roles to ListBox. rolesArray = Roles.GetAllRoles(); RolesListBox.DataSource = rolesArray; RolesListBox.DataBind(); } } public void DeleteRole_OnClick(object sender, EventArgs args) { string delRole = ""; try { delRole = RolesListBox.SelectedItem.Value; Roles.DeleteRole(delRole); Msg.Text = "Role '" + Server.HtmlEncode(delRole) + "' deleted."; // Re-bind roles to ListBox. rolesArray = Roles.GetAllRoles(); RolesListBox.DataSource = rolesArray; RolesListBox.DataBind(); } catch { Msg.Text = "Role '" + Server.HtmlEncode(delRole) + "' <u>not</u> deleted."; } } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head> <title>Sample: Delete Role</title> </head> <body> <form runat="server" id="PageForm"> <h3> Delete Role</h3> <asp:Label ID="Msg" ForeColor="maroon" runat="server" /><br /> <table border="0"> <tr> <td valign="top"> Delete Role:</td> <td valign="top"> <asp:ListBox ID="RolesListBox" runat="server" Rows="8" /></td> <td valign="top"> <asp:Button Text="Delete Role" ID="DeleteRoleButton" runat="server" OnClick="DeleteRole_OnClick" /></td> </tr> </table> </form> </body> </html>
Reference
Roles ClassRoles Members
System.Web.Security Namespace
Other Resources
Understanding Role ManagementCommunity Additions
ADD
Show: