Export (0) Print
Expand All

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)

'Declaration
Public NotInheritable Class MembershipSection
	Inherits ConfigurationSection
'Usage
Dim instance As MembershipSection

public final class MembershipSection extends ConfigurationSection
public final class MembershipSection extends ConfigurationSection
Not applicable.

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.

Imports System
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.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.
        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

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 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft