Roles.Providers プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

Roles.Providers プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ASP.NET アプリケーションのロールプロバイダのコレクションを取得します。

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

Visual Basic (宣言)

Public Shared ReadOnly Property
 Providers As RoleProviderCollection

Visual Basic (使用法)

Dim value As RoleProviderCollection

value = Roles.Providers

public static RoleProviderCollection Providers
 { get; }

C++

public:
static property RoleProviderCollection^ Providers {
    RoleProviderCollection^ get ();
}

/** @property */
public static RoleProviderCollection get_Providers
 ()

JScript

public static function get
 Providers () : RoleProviderCollection

プロパティ値
ASP.NET アプリケーション用に構成されたロールプロバイダを含む RoleProviderCollection。

例外

例外の種類	条件
System.Configuration.Provider.ProviderException	ロール管理は有効になっていません。

解説

Providers プロパティは、Web.config ファイルに追加されているすべてのプロバイダを含めて、アプリケーションに対して有効になっているすべてのロールプロバイダを参照します。アプリケーションで使用可能にするロールプロバイダは、アプリケーションの Web.config ファイルの roleManager セクションの providers 要素を使用して制御できます。

Machine.config ファイルに指定したプロバイダなどの既存のプロバイダを削除し、SqlRoleProvider インスタンスをアプリケーションのロールプロバイダとして追加する roleManager セクションのコード例を次に示します。

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=MySqlServer;Integrated
 Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>

  <system.web>
    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="false"
      cookieSlidingExpiration="true"
      cookieProtection="Encrypted">

      <providers>
        <clear/>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices"
          applicationName="MyApplication" />
         </providers>

    </roleManager>
  </system.web>
</configuration>

ロールプロバイダに対し名前によるインデックスを付け、必要な型としてキャストすることによって、Providers コレクションからプロバイダへの厳密に型指定された参照を取得できます。

Provider プロパティを使用すると、アプリケーションの既定のプロバイダへの参照を取得できます。

使用例

アプリケーションに対して有効なプロバイダとそれらの種類をリストするコードの例を次に示します。

Visual Basic

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security"
 %>
<%@ Import Namespace="System.Configuration.Provider"
 %>
<html>
<head>
<title>List Enabled Providers</title>
</head>
<body>

<%
For Each p As RoleProvider
 In Roles.Providers
  Response.Write(p.Name & ", " & p.GetType().ToString()
 & "<BR>")
Next
%>

</body>
</html>

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Configuration.Provider" %>
<html>
<head>
<title>List Enabled Providers</title>
</head>
<body>

<%
foreach (RoleProvider p in Roles.Providers)
  Response.Write(p.Name + ", " + p.GetType() + "<BR>");
%>

</body>
</html>