SqlRoleProvider.DeleteRole メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SqlRoleProvider.DeleteRole メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

ロールデータベースからロールを削除します。

名前空間: System.Web.Security
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 DeleteRole ( _
    roleName As String, _
    throwOnPopulatedRole As Boolean _
) As Boolean

Visual Basic (使用法)

Dim instance As SqlRoleProvider
Dim roleName As String
Dim throwOnPopulatedRole As Boolean
Dim returnValue As Boolean

returnValue = instance.DeleteRole(roleName, throwOnPopulatedRole)

public override bool DeleteRole (
    string roleName,
    bool throwOnPopulatedRole
)

C++

public:
virtual bool DeleteRole (
    String^ roleName, 
    bool throwOnPopulatedRole
) override

public boolean DeleteRole (
    String roleName, 
    boolean throwOnPopulatedRole
)

JScript

public override function DeleteRole (
    roleName : String, 
    throwOnPopulatedRole : boolean
) : boolean

パラメータ

roleName: 削除するロールの名前。

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

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

例外

例外の種類	条件
System.ArgumentNullException	roleName が null 参照 (Visual Basic では Nothing) (Visual Basic の場合は Nothing) です。
System.ArgumentException	roleName が空の文字列であるか、またはコンマ (,) を含んでいます。または roleName が 256 文字を超えています。
System.Configuration.Provider.ProviderException	roleName に 1 つ以上のメンバがあり、throwOnPopulatedRole は true です。またはデータベースとの通信中に不明なエラーが発生しました。

例外の種類

条件

System.ArgumentNullException

roleName が null 参照 (Visual Basic では Nothing) (Visual Basic の場合は Nothing) です。

System.ArgumentException

roleName が空の文字列であるか、またはコンマ (,) を含んでいます。

または

roleName が 256 文字を超えています。

System.Configuration.Provider.ProviderException

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

または

データベースとの通信中に不明なエラーが発生しました。

解説

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

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

使用例

データベースからファイルを削除する例を次に示します。ロール管理を有効にする Web.config ファイルの例については、SqlRoleProvider のトピックを参照してください。

Visual Basic

<%@ Page Language="VB" %>

<%@ Import Namespace="System.Web.Security"
 %>

<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>
<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="C#" %>

<%@ Import Namespace="System.Web.Security" %>

<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>
<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 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlRoleProvider クラス
SqlRoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール管理について

>> 「SqlRoleProvider.DeleteRole メソッド」を含む用語の索引
SqlRoleProvider.DeleteRole メソッドのページへのリンク


	© 2024 Microsoft.All rights reserved.

SqlRoleProvider.DeleteRole メソッドとは？ わかりやすく解説

SqlRoleProvider.DeleteRole メソッド

急上昇のことば

SqlRoleProvider.DeleteRole メソッドとは？わかりやすく解説