SessionStateSection 类

定义

配置 Web 应用程序的会话状态。

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

示例

本部分提供了两个代码示例。 第一个演示如何以声明方式为节的 sessionState 多个属性指定值,该属性也可以作为类的成员 SessionStateSection 进行访问。 第二个演示了如何使用 SessionStateSection 类。

以下配置文件示例演示如何以声明方式为 sessionState 节指定值。

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

下面的代码示例演示如何使用该 SessionStateSection 类。

// 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");
' Get the Web application configuration.
Dim configuration As System.Configuration.Configuration = _
System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration("/aspnetTest")

' Get the section.
Dim sessionStateSection As System.Web.Configuration.SessionStateSection = _
CType(configuration.GetSection("system.web/sessionState"), _
  System.Web.Configuration.SessionStateSection)

注解

SessionStateSection 类引用由标记标识 sessionState 的 Machine.config 或 Web.config 配置文件中的元素。

当新的客户端开始与 Web 应用程序交互时,会发出会话 ID,并在会话有效期间与同一客户端的所有后续请求相关联。 此 ID 用于维护与跨请求的客户端会话关联的服务器端状态。 SessionStateSection控制 ASP.NET 应用程序如何代表每个客户端建立和维护此关联。

此机制非常灵活,使你能够在进程外托管会话状态信息,并在不使用 Cookie 的情况下跟踪状态。

构造函数

名称 说明
SessionStateSection()

初始化 SessionStateSection 类的新实例。

属性

名称 说明
AllowCustomSqlDatabase

获取或设置一个值,该值指示用户是否可以在属性中 SqlConnectionString 指定初始目录值。

CompressionEnabled

获取或设置一个值,该值指示是否为会话状态数据启用压缩。

Cookieless

获取或设置一个值,该值指示 Cookie 是否用于标识客户端会话。

CookieName

获取或设置 Cookie 名称。

CookieSameSite

获取或设置 Cookie 的 SameSite 属性的值。

CurrentConfiguration

获取对顶级 Configuration 实例的引用,该实例表示当前 ConfigurationElement 实例所属的配置层次结构。

(继承自 ConfigurationElement)
CustomProvider

Providers 集合中获取或设置自定义提供程序的名称。

ElementInformation

获取一个 ElementInformation 对象,该对象包含 ConfigurationElement 对象的不可自定义信息和功能。

(继承自 ConfigurationElement)
ElementProperty

获取表示 ConfigurationElementProperty 对象本身的 ConfigurationElement 对象。

(继承自 ConfigurationElement)
EvaluationContext

获取 ContextInformation 对象的 ConfigurationElement 对象。

(继承自 ConfigurationElement)
HasContext

获取一个值,该值指示 CurrentConfiguration 属性是否 null

(继承自 ConfigurationElement)
Item[ConfigurationProperty]

获取或设置此配置元素的属性或属性。

(继承自 ConfigurationElement)
Item[String]

获取或设置此配置元素的属性、属性或子元素。

(继承自 ConfigurationElement)
LockAllAttributesExcept

获取锁定属性的集合。

(继承自 ConfigurationElement)
LockAllElementsExcept

获取锁定元素的集合。

(继承自 ConfigurationElement)
LockAttributes

获取锁定属性的集合。

(继承自 ConfigurationElement)
LockElements

获取锁定元素的集合。

(继承自 ConfigurationElement)
LockItem

获取或设置一个值,该值指示元素是否已锁定。

(继承自 ConfigurationElement)
Mode

获取或设置一个值,该值指定存储会话状态的位置。

PartitionResolverType

获取或设置一个值,该值指定存储会话状态的位置。

Properties

获取属性的集合。

(继承自 ConfigurationElement)
Providers

获取当前 ProviderSettingsCollection 提供程序。

RegenerateExpiredSessionId

获取或设置一个值,该值指示在客户端指定过期的会话 ID 时是否重新颁发会话 ID。

SectionInformation

获取一个 SectionInformation 对象,该对象包含不可自定义的信息和功能 ConfigurationSection

(继承自 ConfigurationSection)
SessionIDManagerType

获取或设置一个值,该值指定会话 ID 管理器的完全限定类型。

SqlCommandTimeout

获取或设置使用 SQL Server 会话状态模式的 SQL 命令的持续时间超时。

SqlConnectionRetryInterval

获取或设置 ASP.NET 重新连接到数据库之前应经过的时间间隔。

SqlConnectionString

获取或设置 SQL 连接字符串。

StateConnectionString

获取或设置状态服务器连接字符串。

StateNetworkTimeout

获取或设置 Web 服务器与状态服务器之间的网络连接可以保持空闲的时间量。

Timeout

获取或设置会话超时。

UseHostingIdentity

获取或设置一个值,该值指定会话状态在可用时是否使用客户端模拟,或者始终还原到托管标识。

方法

名称 说明
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)

创建一个 XML 字符串,该字符串包含对象的未合并视图 ConfigurationSection 作为要写入文件的单个节。

(继承自 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)

适用于

另请参阅