RoleProvider.GetAllRoles メソッド

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

RoleProvider.GetAllRoles メソッド

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

構成済みの applicationName のすべてのロールのリストを取得します。

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

Visual Basic (宣言)

Public MustOverride Function
 GetAllRoles As String()

Visual Basic (使用法)

Dim instance As RoleProvider
Dim returnValue As String()

returnValue = instance.GetAllRoles

C#

public abstract string[] GetAllRoles ()

C++

public:
virtual array<String^>^ GetAllRoles () abstract

J#

public abstract String[] GetAllRoles ()

JScript

public abstract function GetAllRoles () : String[]

戻り値
構成済みの applicationName のデータ ソースに保存されているすべてのロール名を格納している文字列配列。

解説

GetAllRoles は Roles クラスの GetAllRoles メソッドによって呼び出され、データ ソースからすべてのロール名のリストを取得します。指定された ApplicationName のロールのみ取得されます。

構成済みの applicationName にロールが存在しない場合、プロバイダから要素のない文字列配列を返すことをお勧めします。

使用例

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

Visual Basic

Public Overrides Function
 GetAllRoles() As String() 
  Dim tmpRoleNames As String
 = ""

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

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

  Dim reader As OdbcDataReader = Nothing

  Try
    conn.Open()

    reader = cmd.ExecuteReader()

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

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

  Return New String() {}
End Function

C#

public override string[] GetAllRoles()
{
  string tmpRoleNames = "";

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

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

  OdbcDataReader reader = null;

  try
  {
    conn.Open();

    reader = cmd.ExecuteReader();

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

  if (tmpRoleNames.Length > 0)
  {
    // Remove trailing comma.
    tmpRoleNames = tmpRoleNames.Substring(0, tmpRoleNames.Length - 1);
    return tmpRoleNames.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 名前空間
その他の技術情報
ロール プロバイダの実装