Roles.DeleteRole Método
Definição
Remove uma função da fonte de dados.Removes a role from the data source.
Sobrecargas
| DeleteRole(String, Boolean) |
Remove uma função da fonte de dados.Removes a role from the data source. |
| DeleteRole(String) |
Remove uma função da fonte de dados.Removes a role from the data source. |
DeleteRole(String, Boolean)
Remove uma função da fonte de dados.Removes a role from the data source.
public:
static bool DeleteRole(System::String ^ roleName, bool throwOnPopulatedRole);
public static bool DeleteRole (string roleName, bool throwOnPopulatedRole);
static member DeleteRole : string * bool -> bool
Public Shared Function DeleteRole (roleName As String, throwOnPopulatedRole As Boolean) As Boolean
Parâmetros
- roleName
- String
O nome da função a ser excluída.The name of the role to delete.
- throwOnPopulatedRole
- Boolean
Se true, gerará uma exceção se roleName tiver um ou mais membros.If true, throws an exception if roleName has one or more members.
Retornos
true se roleName tiver sido excluído da fonte de dados; caso contrário, false.true if roleName was deleted from the data source; otherwise; false.
Exceções
roleName é null.roleName is null.
roleName é uma cadeia de caracteres vazia.roleName is an empty string.
roleName tem um ou mais membros e throwOnPopulatedRole é true.roleName has one or more members and throwOnPopulatedRole is true.
- ou --or-
O gerenciamento de função não está habilitado.Role management is not enabled.
Exemplos
O exemplo de código a seguir exclui uma função da fonte de dados.The following code example deletes a role from the data source. Para obter um exemplo de um arquivo de Web.config que habilita o gerenciamento de função, consulte Roles .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>
<%@ 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>
Comentários
O DeleteRole método Remove um nome de função da fonte de dados.The DeleteRole method removes a role name from the data source. DeleteRole chama o DeleteRole método do provedor de função padrão para remover a função especificada da fonte de dados.DeleteRole calls the DeleteRole method of the default role provider to remove the specified role from the data source.
Se throwOnPopulatedRole for true , uma exceção será lançada e a função não será excluída se a função identificada pelo roleName parâmetro tiver um ou mais membros.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. Se throwOnPopulatedRole for false , a função será excluída se estiver vazia ou não.If throwOnPopulatedRole is false, then the role will be deleted whether it is empty or not.
Aplica-se a
DeleteRole(String)
Remove uma função da fonte de dados.Removes a role from the data source.
public:
static bool DeleteRole(System::String ^ roleName);
public static bool DeleteRole (string roleName);
static member DeleteRole : string -> bool
Public Shared Function DeleteRole (roleName As String) As Boolean
Parâmetros
- roleName
- String
O nome da função a ser excluída.The name of the role to delete.
Retornos
true se roleName tiver sido excluído da fonte de dados; caso contrário, false.true if roleName was deleted from the data source; otherwise, false.
Exceções
roleName é null.roleName is null.
roleName é uma cadeia de caracteres vazia ou contém uma vírgula (,).roleName is an empty string or contains a comma (,).
roleName tem um ou mais membros.roleName has one or more members.
- ou --or-
O gerenciamento de função não está habilitado.Role management is not enabled.
Exemplos
O exemplo de código a seguir exclui uma função da fonte de dados.The following code example deletes a role from the data source. Para obter um exemplo de um arquivo de Web.config que habilita o gerenciamento de função, consulte Roles .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>
<%@ 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>
Comentários
O DeleteRole método Remove um nome de função da fonte de dados.The DeleteRole method removes a role name from the data source. DeleteRole chama o DeleteRole método do provedor de função padrão para remover a função especificada da fonte de dados.DeleteRole calls the DeleteRole method of the default role provider to remove the specified role from the data source.
Se a função identificada pelo roleName parâmetro tiver um ou mais membros, uma exceção será lançada e a função não será excluída.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.