RoleProvider.GetUsersInRole メソッド

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

RoleProvider.GetUsersInRole メソッド

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

構成済みの applicationName の指定されたロールに属するユーザーのリストを取得します。

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

Visual Basic (宣言)

Public MustOverride Function
 GetUsersInRole ( _
    roleName As String _
) As String()

Visual Basic (使用法)

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

returnValue = instance.GetUsersInRole(roleName)

C#

public abstract string[] GetUsersInRole (
    string roleName
)

C++

public:
virtual array<String^>^ GetUsersInRole (
    String^ roleName
) abstract

J#

public abstract String[] GetUsersInRole (
    String roleName
)

JScript

public abstract function GetUsersInRole (
    roleName : String
) : String[]

パラメータ

roleName

ユーザーについて一覧を取得するロールの名前。

戻り値
構成済みの applicationName の指定されたロールのメンバであるすべてのユーザーの名前を格納している文字列配列。

解説

GetUsersInRole は Roles クラスの GetUsersInRole メソッドによって呼び出され、ロールに関連付けられているユーザー名をデータ ソースから取得します。構成済みの ApplicationName のロールのみ取得されます。

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

構成済みの applicationName の指定されたロールに関連付けられているユーザーがない場合、プロバイダから要素のない文字列配列を返すことをお勧めします。

使用例

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

Visual Basic

Public Overrides Function
 GetUsersInRole(rolename As String) As
 String() 
  If rolename Is Nothing
 OrElse rolename = "" Then
 _
    Throw New ProviderException("Role
 name cannot be empty or null.")
  If Not RoleExists(rolename) Then
 _
    Throw New ProviderException("Role
 does not exist.")

  Dim tmpUserNames As String
 = ""

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

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

  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 New String() {}
End Function

C#

public override string[] GetUsersInRole(string
 rolename)
{
  if (rolename == null || rolename == "")
    throw new ProviderException("Role name cannot be empty
 or null.");
  if (!RoleExists(rolename))
    throw new ProviderException("Role does not exist.");

  string tmpUserNames = "";

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

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

  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 new string[0];
}

プラットフォーム

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