RoleProvider.IsUserInRole メソッド

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

RoleProvider.IsUserInRole メソッド

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

指定されたユーザーが、構成済みの applicationName の指定されたロールに存在するかどうかを示す値を取得します。

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

Visual Basic (宣言)

Public MustOverride Function
 IsUserInRole ( _
    username As String, _
    roleName As String _
) As Boolean

Visual Basic (使用法)

Dim instance As RoleProvider
Dim username As String
Dim roleName As String
Dim returnValue As Boolean

returnValue = instance.IsUserInRole(username, roleName)

C#

public abstract bool IsUserInRole (
    string username,
    string roleName
)

C++

public:
virtual bool IsUserInRole (
    String^ username, 
    String^ roleName
) abstract

J#

public abstract boolean IsUserInRole (
    String username, 
    String roleName
)

JScript

public abstract function IsUserInRole (
    username : String, 
    roleName : String
) : boolean

パラメータ

username

検索するユーザー名。

roleName

検索範囲とするロール。

戻り値
指定されたユーザーが構成済みの applicationName の指定されたロールにある場合は true。それ以外の場合は false。

解説

IsUserInRole メソッドは、Roles クラスの IsUserInRole メソッドと RolePrincipal クラスの IsInRole メソッドによって呼び出され、現在ログオンしているユーザーが、構成済みの ApplicationName のデータ ソースのロールに関連付けられているかどうかを判断します。

指定されたユーザー名が null 参照 (Visual Basic では Nothing) または空の文字列である場合、プロバイダから例外をスローすることをお勧めします。

指定されたロール名が null 参照 (Visual Basic では Nothing) または空の文字列である場合、プロバイダから例外をスローすることをお勧めします。

使用例

IsUserInRole メソッドの実装サンプルを次のコード例に示します。

Visual Basic

Public Overrides Function
 IsUserInRole(username As String, rolename
 As String) As Boolean 
  If username Is Nothing
 OrElse username = "" Then
 _
    Throw New ProviderException("User
 name cannot be empty or null.")
  If rolename Is Nothing
 OrElse rolename = "" Then
 _
    Throw New ProviderException("Role
 name cannot be empty or null.")

  Dim userIsInRole As Boolean
 = False

  Dim conn As OdbcConnection = New
 OdbcConnection(connectionString)
  Dim cmd As OdbcCommand = New
 OdbcCommand("SELECT COUNT(*) FROM [" & usersInRolesTable
 & "]" & _
                                           " WHERE Username =
 ? AND Rolename = ? AND ApplicationName = ?", conn)

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

  Try
    conn.Open()

    Dim numRecs As Integer
 = CType(cmd.ExecuteScalar(), Integer)

    If numRecs > 0 Then
      userIsInRole = True
    End If
  Catch e As OdbcException
    ' Handle exception.
  Finally
    conn.Close()      
  End Try

  Return userIsInRole
End Function

C#

public override bool IsUserInRole(string
 username, string rolename)
{
  if (username == null || username == "")
    throw new ProviderException("User name cannot be empty
 or null.");
  if (rolename == null || rolename == "")
    throw new ProviderException("Role name cannot be empty
 or null.");

  bool userIsInRole = false;

  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("SELECT COUNT(*) FROM
 [" + usersInRolesTable + "]"  +
                                    " WHERE Username = ? AND Rolename = ? AND
 ApplicationName = ?", conn);

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

  try
  {
    conn.Open();

    int numRecs = (int)cmd.ExecuteScalar();

    if (numRecs > 0)
    {
      userIsInRole = true;
    }
  }
  catch (OdbcException)
  {
    // Handle exception.
  }
  finally
  {
    conn.Close();      
  }

  return userIsInRole;
}

プラットフォーム

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

参照

関連項目
RoleProvider クラス
RoleProvider メンバ
System.Web.Security 名前空間
その他の技術情報
ロール プロバイダの実装