MembershipSection クラス

定義

メンバーシップの詳細を構成および管理するためのインフラストラクチャをサポートする構成設定を定義します。 このクラスは継承できません。

public ref class MembershipSection sealed : System::Configuration::ConfigurationSection
public sealed class MembershipSection : System.Configuration.ConfigurationSection
type MembershipSection = class
    inherit ConfigurationSection
Public NotInheritable Class MembershipSection
Inherits ConfigurationSection
継承

この例では、 membership セクションのいくつかの属性に対して宣言的に値を指定する方法を示します。これは、 MembershipSection クラスのメンバーとしてもアクセスできます。

次の構成ファイルの例は、 membership セクションに対して宣言によって値を指定する方法を示しています。

<system.web>
  <membership
    defaultProvider="AspNetSqlMembershipProvider"
    userIsOnlineTimeWindow="15">
    <providers>
      <add
        name=" AspNetSqlMembershipProvider"
        type="System.Web.Security.SqlMembershipProvider, System.Web,
          Version=2.0.3600.0, Culture=neutral,
          PublicKeyToken=b03f5f7f11d50a3a"
        connectionStringName="LocalSqlServer"
        passwordAttemptThreshold="5"
        passwordAttemptWindow="10"
        enablePasswordRetrieval="false"
        enablePasswordReset="true"
        requiresQuestionAndAnswer="true"
        applicationName="/"
        requiresUniqueEmail="false"
        passwordFormat="Hashed"
        description="Stores and retrieves membership data from
          the local Microsoft SQL Server database."
      />
    </providers>
  </membership>
</system.web>

次のコード例は、 MembershipSection クラスの使用方法を示しています。

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingMembershipSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";

        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        MembershipSection configSection =
          (MembershipSection)config.GetSection("system.web/membership");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}",
          config.FilePath);
        Console.WriteLine("Section Path: {0}",
          configSection.SectionInformation.Name);

        // Display Default Provider.
        Console.WriteLine("DefaultProvider: {0}",
          configSection.DefaultProvider);

        // Set Default Provider.
        configSection.DefaultProvider =
          "AspNetSqlRoleProvider";

        // Display HashAlgorithmType value.
        Console.WriteLine("HashAlgorithmType: {0}", 
          configSection.HashAlgorithmType);

        // Set HashAlgorithmType value.
        configSection.HashAlgorithmType = 
          MachineKeyValidation.HMACSHA256.ToString();

        // Display UserIsOnlineTimeWindow value.
        Console.WriteLine("UserIsOnlineTimeWindow: {0}", 
          configSection.UserIsOnlineTimeWindow);

        // Set UserIsOnlineTimeWindow value.
        configSection.UserIsOnlineTimeWindow = 
          TimeSpan.FromMinutes(15) ;

        // Display the number of Providers.
        Console.WriteLine("Providers Collection Count: {0}",
          configSection.Providers.Count);

        // Display elements of the Providers collection property.
        foreach (ProviderSettings providerItem in configSection.Providers)
        {
          Console.WriteLine();
          Console.WriteLine("Provider Details:");
          Console.WriteLine("Name: {0}", providerItem.Name);
          Console.WriteLine("Type: {0}", providerItem.Type);
        }

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }

      catch (Exception e)
      {
        // Unknown error.
        Console.WriteLine(e.ToString());
      }

      // Display and wait.
      Console.ReadLine();
    }
  }
}
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingMembershipSection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.MembershipSection = _
         CType(config.GetSection("system.web/membership"), _
         System.Web.Configuration.MembershipSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", _
         config.FilePath)
        Console.WriteLine("Section Path: {0}", _
         configSection.SectionInformation.Name)

        ' Display Default Provider.
        Console.WriteLine("DefaultProvider: {0}", _
         configSection.DefaultProvider)

        ' Set Default Provider.
        configSection.DefaultProvider = _
         "AspNetSqlRoleProvider"

        ' Display HashAlgorithmType value.
        Console.WriteLine("HashAlgorithmType: {0}", _
         configSection.HashAlgorithmType)

        ' Set HashAlgorithmType value.
        configSection.HashAlgorithmType = _
         MachineKeyValidation.HMACSHA256.ToString()

        ' Display UserIsOnlineTimeWindow value.
        Console.WriteLine("UserIsOnlineTimeWindow: {0}", _
         configSection.UserIsOnlineTimeWindow)

        ' Set UserIsOnlineTimeWindow value.
        configSection.UserIsOnlineTimeWindow = _
         TimeSpan.FromMinutes(15)

        ' Display the number of Providers.
        Console.WriteLine("Providers Collection Count: {0}", _
         configSection.Providers.Count)

        ' Display elements of the Providers collection property.
        For Each providerItem As ProviderSettings In configSection.Providers()
          Console.WriteLine()
          Console.WriteLine("Provider Details:")
          Console.WriteLine("Name: {0}", providerItem.Name)
          Console.WriteLine("Type: {0}", providerItem.Type)
        Next

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait.
      Console.ReadLine()
    End Sub
  End Class
End Namespace

注釈

MembershipSection クラスは、構成ファイル内のmembership セクションにプログラムでアクセスして変更する方法を提供します。

コンストラクター

名前 説明
MembershipSection()

MembershipSection クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
CurrentConfiguration

現在のConfiguration インスタンスが属している構成階層を表す最上位ConfigurationElement インスタンスへの参照を取得します。

(継承元 ConfigurationElement)
DefaultProvider

ロールの管理に使用される既定のプロバイダーの名前を取得または設定します。

ElementInformation

ElementInformation オブジェクトのカスタマイズ不可能な情報と機能を含むConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
ElementProperty

ConfigurationElementProperty オブジェクト自体を表すConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
EvaluationContext

ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
HasContext

CurrentConfiguration プロパティがnullされているかどうかを示す値を取得します。

(継承元 ConfigurationElement)
HashAlgorithmType

機密性の高いメンバーシップ情報に使用される暗号化の種類を取得または設定します。

Item[ConfigurationProperty]

この構成要素のプロパティまたは属性を取得または設定します。

(継承元 ConfigurationElement)
Item[String]

この構成要素のプロパティ、属性、または子要素を取得または設定します。

(継承元 ConfigurationElement)
LockAllAttributesExcept

ロックされた属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockAllElementsExcept

ロックされた要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockAttributes

ロックされた属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockElements

ロックされた要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockItem

要素がロックされているかどうかを示す値を取得または設定します。

(継承元 ConfigurationElement)
Properties

プロパティのコレクションを取得します。

(継承元 ConfigurationElement)
Providers

ProviderSettingsCollection オブジェクトのProviderSettings オブジェクトを取得します。

SectionInformation

SectionInformation オブジェクトのカスタマイズ不可能な情報と機能を含むConfigurationSection オブジェクトを取得します。

(継承元 ConfigurationSection)
UserIsOnlineTimeWindow

ユーザーがオンラインと見なされなくなるまでの時間を分単位で取得または設定します。

メソッド

名前 説明
DeserializeElement(XmlReader, Boolean)

構成ファイルから XML を読み取ります。

(継承元 ConfigurationElement)
DeserializeSection(XmlReader)

構成ファイルから XML を読み取ります。

(継承元 ConfigurationSection)
Equals(Object)

現在の ConfigurationElement インスタンスを指定したオブジェクトと比較します。

(継承元 ConfigurationElement)
GetHashCode()

現在の ConfigurationElement インスタンスを表す一意の値を取得します。

(継承元 ConfigurationElement)
GetRuntimeObject()

派生クラスでオーバーライドされると、カスタム オブジェクトを返します。

(継承元 ConfigurationSection)
GetTransformedAssemblyString(String)

指定したアセンブリ名の変換されたバージョンを返します。

(継承元 ConfigurationElement)
GetTransformedTypeString(String)

指定した型名の変換されたバージョンを返します。

(継承元 ConfigurationElement)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
Init()

ConfigurationElement オブジェクトを初期状態に設定します。

(継承元 ConfigurationElement)
InitializeDefault()

ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。

(継承元 ConfigurationElement)
IsModified()

この構成要素が最後に保存されてから変更されたか、派生クラスに実装されたときに読み込まれたかを示します。

(継承元 ConfigurationSection)
IsReadOnly()

ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。

(継承元 ConfigurationElement)
ListErrors(IList)

この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティ エラーを、渡されたリストに追加します。

(継承元 ConfigurationElement)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)

逆シリアル化中に不明な属性が検出されたかどうかを示す値を取得します。

(継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

逆シリアル化中に不明な要素が検出されたかどうかを示す値を取得します。

(継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)

必要なプロパティが見つからない場合に例外をスローします。

(継承元 ConfigurationElement)
PostDeserialize()

逆シリアル化後に呼び出されます。

(継承元 ConfigurationElement)
PreSerialize(XmlWriter)

シリアル化の前に呼び出されます。

(継承元 ConfigurationElement)
Reset(ConfigurationElement)

ロックやプロパティ コレクションなど、 ConfigurationElement オブジェクトの内部状態をリセットします。

(継承元 ConfigurationElement)
ResetModified()

派生クラスで実装されたときに IsModified() メソッドの値を false にリセットします。

(継承元 ConfigurationSection)
SerializeElement(XmlWriter, Boolean)

派生クラスで実装されている場合、この構成要素の内容を構成ファイルに書き込みます。

(継承元 ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

ファイルに書き込む単一のセクションとして、 ConfigurationSection オブジェクトの結合されていないビューを含む XML 文字列を作成します。

(継承元 ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)

派生クラスで実装されるときに、この構成要素の外部タグを構成ファイルに書き込みます。

(継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

プロパティを指定した値に設定します。

(継承元 ConfigurationElement)
SetReadOnly()

IsReadOnly() オブジェクトとすべてのサブ要素のConfigurationElement プロパティを設定します。

(継承元 ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

.NET Framework の指定したターゲット バージョンに対して構成オブジェクト階層をシリアル化するときに、指定した要素をシリアル化するかどうかを示します。

(継承元 ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

.NET Framework の指定したターゲット バージョンに対して構成オブジェクト階層をシリアル化するときに、指定したプロパティをシリアル化する必要があるかどうかを示します。

(継承元 ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)

.NET Framework の指定したターゲット バージョンに対して構成オブジェクト階層をシリアル化するときに、現在の ConfigurationSection インスタンスをシリアル化するかどうかを示します。

(継承元 ConfigurationSection)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

ConfigurationElement オブジェクトを変更して、保存すべきでないすべての値を削除します。

(継承元 ConfigurationElement)

適用対象

こちらもご覧ください