Export (0) Print
Expand All

SessionStateSection Class

Configures the session state for a Web application.

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

public sealed class SessionStateSection : ConfigurationSection

The SessionStateSection type exposes the following members.

  NameDescription
Public methodSessionStateSectionInfrastructure. Initializes a new instance of the SessionStateSection class.
Top

  NameDescription
Public propertyAllowCustomSqlDatabaseGets or sets a value indicating whether the user can specify the initial catalog value in the SqlConnectionString property.
Public propertyCompressionEnabledGets or sets a value that indicates whether compression is enabled for session-state data.
Public propertyCookielessGets or sets a value indicating whether cookies are used to identify client sessions.
Public propertyCookieNameGets or sets the cookie name.
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyCustomProviderGets or sets the name of the custom provider from the Providers collection.
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyModeGets or sets a value specifying where to store the session state.
Public propertyPartitionResolverTypeGets or sets a value specifying where to store the session state.
Protected propertyPropertiesGets the collection of properties. (Inherited from ConfigurationElement.)
Public propertyProvidersGets the current ProviderSettingsCollection providers.
Public propertyRegenerateExpiredSessionIdGets or sets a value indicating whether the session Id will be re-issued when an expired session ID is specified by the client.
Public propertySectionInformationGets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.)
Public propertySessionIDManagerTypeGets or sets a value specifying the fully qualified type of session ID Manager.
Public propertySqlCommandTimeoutGets or sets the duration time-out for the SQL commands using the SQL Server session state mode.
Public propertySqlConnectionRetryIntervalGets or sets the time interval that should elapse before ASP.NET reconnects to the database.
Public propertySqlConnectionStringGets or sets the SQL connection string.
Public propertyStateConnectionStringGets or sets the state server connection string.
Public propertyStateNetworkTimeoutGets or sets the amount of time the network connection between the Web server and the state server can remain idle.
Public propertyTimeoutGets or sets the session time-out
Public propertyUseHostingIdentityGets or sets a value specifying the whether the session state will use client impersonation when available, or will always revert to the hosting identity.
Top

  NameDescription
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Protected methodDeserializeSectionInfrastructure. Reads XML from the configuration file. (Inherited from ConfigurationSection.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Protected methodGetRuntimeObjectReturns a custom object when overridden in a derived class. (Inherited from ConfigurationSection.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodIsModifiedIndicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class. (Inherited from ConfigurationSection.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationSection.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeSectionInfrastructure. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file. (Inherited from ConfigurationSection.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Protected methodShouldSerializeElementInTargetVersionIndicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Protected methodShouldSerializePropertyInTargetVersionIndicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Protected methodShouldSerializeSectionInTargetVersionIndicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework. (Inherited from ConfigurationSection.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The SessionStateSection class refers to the element in the Machine.config or Web.config configuration file identified by the sessionState tag.

When a new client begins interacting with a Web application, a session ID is issued and associated with all the subsequent requests from the same client during the time that the session is valid. This ID is used to maintain server-side state associated with the client session across requests. The SessionStateSection controls how the ASP.NET application establishes and maintains this association on behalf of each client.

This mechanism is very flexible and gives you the ability to host session-state information out of process and to track state without using cookies, among other things.

This section provides two code examples. The first demonstrates how to specify values declaratively for several attributes of the sessionState section, which can also be accessed as members of the SessionStateSection class. The second demonstrates how to use the SessionStateSection class.

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

<configuration>
  <system.web>
    <sessionState mode="InProc" 
      stateConnectionString="tcpip=127.0.0.1:42424" 
      stateNetworkTimeout="10"
      sqlConnectionString="data source=127.0.0.1;
        Integrated Security=SSPI"
      sqlCommandTimeout="30" 
      customProvider="" 
      cookieless="UseDeviceProfile" 
      cookieName="ASP.NET_SessionId" 
      timeout="20" 
      allowCustomSqlDatabase="False" 
      regenerateExpiredSessionId="False" 
      partitionResolverType="" 
      useHostingIdentity="True">
      <providers>
        <clear />
      </providers>
    </sessionState>
  </system.web>
</configuration>

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

// Get the Web application configuration object.
System.Configuration.Configuration configuration =
  System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

// Get the section related object.
System.Web.Configuration.SessionStateSection sessionStateSection =
  (System.Web.Configuration.SessionStateSection)
  configuration.GetSection("system.web/sessionState");

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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