RoleProvider.FindUsersInRole メソッド

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

RoleProvider.FindUsersInRole メソッド

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

指定されたロールで、ユーザー名が指定内容と一致するユーザーの配列を取得します。

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

Visual Basic (宣言)

Public MustOverride Function
 FindUsersInRole ( _
    roleName As String, _
    usernameToMatch As String _
) As String()

Visual Basic (使用法)

Dim instance As RoleProvider
Dim roleName As String
Dim usernameToMatch As String
Dim returnValue As String()

returnValue = instance.FindUsersInRole(roleName, usernameToMatch)

C#

public abstract string[] FindUsersInRole (
    string roleName,
    string usernameToMatch
)

C++

public:
virtual array<String^>^ FindUsersInRole (
    String^ roleName, 
    String^ usernameToMatch
) abstract

J#

public abstract String[] FindUsersInRole (
    String roleName, 
    String usernameToMatch
)

JScript

public abstract function FindUsersInRole (
    roleName : String, 
    usernameToMatch : String
) : String[]

パラメータ

roleName

検索範囲とするロール。

usernameToMatch

検索するユーザー名。

戻り値
usernameToMatch に一致するユーザー名を持ち、指定されたロールのメンバであるすべてのユーザーの名前を格納している文字列配列。

解説

FindUsersInRole メソッドは Roles クラスによって呼び出され、構成された applicationName に対して指定された usernameToMatch に一致するユーザー名を持つロール内のユーザーの一覧を返します。データ ソースによってはワイルドカードがサポートされます。ユーザーは、ユーザー名のアルファベット順に返されます。

roleName がデータ ソースに存在していない場合、ProviderException をスローすることをお勧めします。

使用例

FindUsersInRole を実装するコード例を次に示します。

Visual Basic

Public Overrides Function
 FindUsersInRole(rolename As String, userNameToMatch
 As String) As String() 
  Dim conn As OdbcConnection = New
 OdbcConnection(connectionString)
  Dim cmd As OdbcCommand = New
 OdbcCommand("SELECT Username FROM [" & usersInRolesTable
 & "] " & _
                                           " WHERE Username LIKE
 ? AND RoleName = ? AND ApplicationName = ?", conn)
  cmd.Parameters.Add("@UsernameSearch", OdbcType.VarChar,
 255).Value = usernameToMatch
  cmd.Parameters.Add("@RoleName", OdbcType.VarChar,
 255).Value = rolename
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar,
 255).Value = pApplicationName

  Dim tmpUserNames As String
 = ""
  Dim reader As OdbcDataReader = Nothing

  Try
    conn.Open()

    reader = cmd.ExecuteReader()

    Do While reader.Read()
      tmpUserNames &= reader.GetString(0) & ","
    Loop
  Catch e As OdbcException
    ' Handle exception.
  Finally
    If Not reader Is Nothing
 Then reader.Close()
    conn.Close()
  End Try

  If tmpUserNames.Length > 0 Then      
      
    ' Remove trailing comma.
    tmpUserNames = tmpUserNames.Substring(0, tmpUserNames.Length - 1)
    Return tmpUserNames.Split(CChar(","))
  End If

  Return Nothing
End Function

C#

public override string[] FindUsersInRole(string
 rolename, string usernameToMatch)
{
  OdbcConnection conn = new OdbcConnection(connectionString);
  OdbcCommand cmd = new OdbcCommand("SELECT Username FROM
 [" + usersInRolesTable + "] " +
                                    " WHERE Username LIKE ? AND RoleName = ?
 AND ApplicationName = ?", conn);
  cmd.Parameters.Add("@UsernameSearch", OdbcType.VarChar, 255).Value =
 usernameToMatch;
  cmd.Parameters.Add("@RoleName", OdbcType.VarChar, 255).Value = rolename;
  cmd.Parameters.Add("@ApplicationName", OdbcType.VarChar, 255).Value =
 pApplicationName;

  string tmpUserNames = "";
  OdbcDataReader reader = null;

  try
  { 
    conn.Open();

    reader = cmd.ExecuteReader();

    while (reader.Read())
    {
      tmpUserNames += reader.GetString(0) + ",";
    }
  }
  catch (OdbcException)
  {
    // Handle Exception.
  }
  finally
  {
    if (reader != null) { reader.Close(); }

    conn.Close();
  }

  if (tmpUserNames.Length > 0)
  {
    // Remove trailing comma.
    tmpUserNames = tmpUserNames.Substring(0, tmpUserNames.Length - 1);
    return tmpUserNames.Split(',');
  }

  return null;
}

プラットフォーム

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 名前空間
その他の技術情報
ロール プロバイダの実装