Roles.DeleteRole Method (String)
Removes a role from the data source.
Assembly: System.Web (in System.Web.dll)
'Declaration Public Shared Function DeleteRole ( _ roleName As String _ ) As Boolean 'Usage Dim roleName As String Dim returnValue As Boolean returnValue = Roles.DeleteRole(roleName)
Parameters
- roleName
- Type: System.String
The name of the role to delete.
Return Value
Type: System.Booleantrue if roleName was deleted from the data source; otherwise, false.
| Exception | Condition |
|---|---|
| System.ArgumentNullException | roleName is Nothing. |
| System.ArgumentException | roleName is an empty string or contains a comma (,). |
| System.Configuration.Provider.ProviderException | roleName has one or more members. -or- Role management is not enabled. |
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 the role identified by the roleName parameter has one or more members, then an exception will be thrown and the role will not be deleted.
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="VB" %> <%@ 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"> Dim rolesArray() As String Public Sub Page_Load(ByVal sender As Object, ByVal args As EventArgs) If Not IsPostBack Then ' Bind roles to ListBox. rolesArray = Roles.GetAllRoles() RolesListBox.DataSource = rolesArray RolesListBox.DataBind() End If End Sub Public Sub DeleteRole_OnClick(ByVal sender As Object, ByVal args As EventArgs) Dim delRole As String 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." End Try End Sub </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>
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.