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

定義

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

構成された applicationNameのデータ ソースからロールを削除します。

public:
 abstract bool DeleteRole(System::String ^ roleName, bool throwOnPopulatedRole);
public abstract bool DeleteRole(string roleName, bool throwOnPopulatedRole);
abstract member DeleteRole : string * bool -> bool
Public MustOverride Function DeleteRole (roleName As String, throwOnPopulatedRole As Boolean) As Boolean

パラメーター

roleName
String

削除するロールの名前。

throwOnPopulatedRole
Boolean

true場合は、roleNameに 1 つ以上のメンバーがあり、roleNameを削除しない場合は例外をスローします。

返品

Boolean

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

例

次のコード例は、 DeleteRole メソッドの実装例を示しています。

public override bool DeleteRole(string rolename, bool throwOnPopulatedRole)
{
  if (!RoleExists(rolename))
  {
    throw new ProviderException("Role does not exist.");
  }

  if (throwOnPopulatedRole && GetUsersInRole(rolename).Length > 0)
  {
    throw new ProviderException("Cannot delete a populated role.");
  }

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("DELETE FROM Roles "  +
                                    " WHERE Rolename = ? AND ApplicationName = ?", conn);

  cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename;
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  OdbcCommand cmd2 = new OdbcCommand("DELETE FROM UsersInRoles "  +
                                     " WHERE Rolename = ? AND ApplicationName = ?", conn);

  cmd2.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename;
  cmd2.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName;

  try
  {
    conn.Open();

    cmd2.ExecuteNonQuery();
    cmd.ExecuteNonQuery();
  }
  catch (OdbcException)
  {
    // Handle exception.

    return false;
  }
  finally
  {
    conn.Close();      
  }

  return true;
}

Public Overrides Function DeleteRole(ByVal rolename As String, ByVal throwOnPopulatedRole As Boolean) As Boolean
    If Not RoleExists(rolename) Then
        Throw New ProviderException("Role does not exist.")
    End If

    If throwOnPopulatedRole AndAlso GetUsersInRole(rolename).Length > 0 Then
        Throw New ProviderException("Cannot delete a populated role.")
    End If

    Dim conn As OdbcConnection = New OdbcConnection(connectionString)
    Dim cmd As OdbcCommand = New OdbcCommand("DELETE FROM Roles " & _
                                             " WHERE Rolename = ? AND ApplicationName = ?", conn)

    cmd.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename
    cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName

    Dim cmd2 As OdbcCommand = New OdbcCommand("DELETE FROM UsersInRoles " & _
                                              " WHERE Rolename = ? AND ApplicationName = ?", conn)

    cmd2.Parameters.Add("@Rolename", OdbcType.VarChar, 255).Value = rolename
    cmd2.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value = ApplicationName

    Try
        conn.Open()

        cmd2.ExecuteNonQuery()
        cmd.ExecuteNonQuery()
    Catch e As OdbcException
        ' Handle exception.

        Return False
    Finally
        conn.Close()
    End Try

    Return True
End Function

注釈

DeleteRoleは、構成されたDeleteRoleのデータ ソースから指定されたロールを削除するために、DeleteRole クラスのRolesおよびApplicationName メソッドによって呼び出されます。

データ ソースからロールを削除するときは、構成された applicationNameのユーザー名と削除されたロールの間の関連付けも必ず削除してください。

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

指定したロール名が存在しない場合、 nullされている場合、または空の文字列である場合は、プロバイダーが例外をスローすることをお勧めします。

適用対象

こちらもご覧ください