SessionStateSection Class
TOC
Collapse the table of content
Expand the table of content

SessionStateSection Class

 

Configures the session state for a Web application.

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

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationSection
      System.Web.Configuration.SessionStateSection

public sealed class SessionStateSection : ConfigurationSection

NameDescription
System_CAPS_pubmethodSessionStateSection()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the SessionStateSection class.

NameDescription
System_CAPS_pubpropertyAllowCustomSqlDatabase

Gets or sets a value indicating whether the user can specify the initial catalog value in the SqlConnectionString property.

System_CAPS_pubpropertyCompressionEnabled

Gets or sets a value that indicates whether compression is enabled for session-state data.

System_CAPS_pubpropertyCookieless

Gets or sets a value indicating whether cookies are used to identify client sessions.

System_CAPS_pubpropertyCookieName

Gets or sets the cookie name.

System_CAPS_pubpropertyCurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyCustomProvider

Gets or sets the name of the custom provider from the Providers collection.

System_CAPS_pubpropertyElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)

System_CAPS_protpropertyElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyItem[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_protpropertyItem[String]

Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllAttributesExcept

Gets the collection of locked attributes.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAllElementsExcept

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockAttributes

Gets the collection of locked attributes (Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockElements

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyLockItem

Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyMode

Gets or sets a value specifying where to store the session state.

System_CAPS_pubpropertyPartitionResolverType

Gets or sets a value specifying where to store the session state.

System_CAPS_protpropertyProperties

Gets the collection of properties.(Inherited from ConfigurationElement.)

System_CAPS_pubpropertyProviders

Gets the current ProviderSettingsCollection providers.

System_CAPS_pubpropertyRegenerateExpiredSessionId

Gets or sets a value indicating whether the session Id will be re-issued when an expired session ID is specified by the client.

System_CAPS_pubpropertySectionInformation

Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object. (Inherited from ConfigurationSection.)

System_CAPS_pubpropertySessionIDManagerType

Gets or sets a value specifying the fully qualified type of session ID Manager.

System_CAPS_pubpropertySqlCommandTimeout

Gets or sets the duration time-out for the SQL commands using the SQL Server session state mode.

System_CAPS_pubpropertySqlConnectionRetryInterval

Gets or sets the time interval that should elapse before ASP.NET reconnects to the database.

System_CAPS_pubpropertySqlConnectionString

Gets or sets the SQL connection string.

System_CAPS_pubpropertyStateConnectionString

Gets or sets the state server connection string.

System_CAPS_pubpropertyStateNetworkTimeout

Gets or sets the amount of time the network connection between the Web server and the state server can remain idle.

System_CAPS_pubpropertyTimeout

Gets or sets the session time-out

System_CAPS_pubpropertyUseHostingIdentity

Gets or sets a value specifying the whether the session state will use client impersonation when available, or will always revert to the hosting identity.

NameDescription
System_CAPS_protmethodDeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.(Inherited from ConfigurationElement.)

System_CAPS_protmethodDeserializeSection(XmlReader)

This API supports the product infrastructure and is not intended to be used directly from your code. Reads XML from the configuration file.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodEquals(Object)

Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)

System_CAPS_pubmethodGetHashCode()

Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)

System_CAPS_protmethodGetRuntimeObject()

Returns a custom object when overridden in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodInit()

Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)

System_CAPS_protmethodInitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protmethodIsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_pubmethodIsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)

System_CAPS_protmethodReset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)

System_CAPS_protmethodResetModified()

Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationSection.)

System_CAPS_protmethodSerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

This API supports the product infrastructure and is not intended to be used directly from your code. Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.(Inherited from ConfigurationSection.)

System_CAPS_protmethodSerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethodSetReadOnly()

Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)

System_CAPS_protmethodShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

Indicates 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.)

System_CAPS_protmethodShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

Indicates 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.)

System_CAPS_protmethodShouldSerializeSectionInTargetVersion(FrameworkName)

Indicates 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.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodUnmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

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
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft