AuthorizationStoreRoleProvider.DeleteRole(String, Boolean) メソッド

  • リファレンス

定義

名前空間:
System.Web.Security
アセンブリ:
System.Web.dll

ロールを承認マネージャー ポリシー ストアから削除します。

public:
 override bool DeleteRole(System::String ^ roleName, bool throwOnPopulatedRole);
public override bool DeleteRole (string roleName, bool throwOnPopulatedRole);
override this.DeleteRole : string * bool -> bool
Public Overrides Function DeleteRole (roleName As String, throwOnPopulatedRole As Boolean) As Boolean

パラメーター

roleName
String

削除するロールの名前。

throwOnPopulatedRole
Boolean

true の場合は、roleName に 1 つ以上のメンバーがあれば例外をスローします。

戻り値

Boolean

ロールが正常に削除された場合は true。それ以外の場合は false。

例外

ArgumentNullException

roleName が nullです。

ArgumentException

roleName が空の文字列です。

- または -

roleName にコンマが含まれています。

ProviderException

roleName に 1 つ以上のメンバーがあり、throwOnPopulatedRole は true です。

- または -

構成済みの applicationName が見つかりませんでした。

- または -

構成済みの scopeName が見つかりませんでした。

- または -

承認マネージャー ランタイムがサーバーにインストールされていません。

FileNotFoundException

connectionStringName 属性が、存在しないファイルへの接続文字列を参照しています。

HttpException

AuthorizationStoreRoleProvider インスタンスが、ファイル ベースのポリシー ストアを使用するように構成されていますが、そのポリシー ファイルへの読み込みアクセスが現在の信頼レベルで許可されていません。

例

次の例では、authorization-manager ポリシー ストアからロールを削除します。 ロール管理を有効にする Web.config ファイルの例については、「」を参照してください AuthorizationStoreRoleProvider。


<%@ 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>

注釈

メソッドは DeleteRole 、 クラスによって呼び出され Roles 、ASP.NET アプリケーションの構成ファイル (Web.config) で指定された authorization-manager ポリシー ストアからロールを削除します。 ロールが削除されると、そのロールに関連付けられているユーザーの一覧もポリシー ストアから削除されます。 データベース内のユーザー情報は影響を受けません。

が trueの場合throwOnPopulatedRoleは例外がスローされ、パラメーターによって識別されるロールに 1 つ以上のroleNameメンバーがある場合、ロールは削除されません。 が falseの場合throwOnPopulatedRole、ロールが空かどうかに関係なく削除されます。

適用対象

こちらもご覧ください