MembershipSection Class

Defines configuration settings to support the infrastructure for configuring and managing membership details. This class cannot be inherited.

Namespace:  System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

public sealed class MembershipSection : ConfigurationSection

The MembershipSection class provides a way to programmatically access and modify the membership section in a configuration file.

This example demonstrates how to specify values declaratively for several attributes of the membership section, which can also be accessed as members of the MembershipSection class.

The following configuration file example shows how to specify values declaratively for the membership section.

<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>

The following code example demonstrates how to use the MembershipSection class.

#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.SHA1.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();
    }
  }
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft