SessionStateSection SessionStateSection SessionStateSection SessionStateSection Class

定义

配置 Web 应用程序的会话状态。Configures the session state for a Web application.

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

示例

本部分提供了两个代码示例。This section provides two code examples. 第一个示例演示如何以声明方式为sessionState部分的多个属性指定值, 该部分也可以作为SessionStateSection类的成员进行访问。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. 第二个示例演示如何使用SessionStateSection类。The second demonstrates how to use the SessionStateSection class.

下面的配置文件示例演示如何以声明方式为sessionState节指定值。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>  

下面的代码示例演示如何使用SessionStateSection类。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");
' 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)

注解

类引用 machine.config 或sessionState由标记标识的 web.config 配置文件中的元素。 SessionStateSectionThe SessionStateSection class refers to the element in the Machine.config or Web.config configuration file identified by the sessionState tag.

当新客户端开始与 Web 应用程序交互时, 将在会话有效期间发出会话 ID 并将其与来自同一客户端的所有后续请求关联。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. 此 ID 用于维护每个请求之间与客户端会话关联的服务器端状态。This ID is used to maintain server-side state associated with the client session across requests. SessionStateSection控制 ASP.NET 应用程序代表每个客户端建立和维护此关联的方式。The SessionStateSection controls how the ASP.NET application establishes and maintains this association on behalf of each client.

此机制非常灵活, 并使你能够在进程外托管会话状态信息, 并在不使用 cookie 的情况下跟踪状态。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.

构造函数

SessionStateSection() SessionStateSection() SessionStateSection() SessionStateSection()

初始化 SessionStateSection 类的新实例。Initializes a new instance of the SessionStateSection class.

属性

AllowCustomSqlDatabase AllowCustomSqlDatabase AllowCustomSqlDatabase AllowCustomSqlDatabase

获取或设置一个值,该值指示用户能否在 SqlConnectionString 属性中指定初始目录值。Gets or sets a value indicating whether the user can specify the initial catalog value in the SqlConnectionString property.

CompressionEnabled CompressionEnabled CompressionEnabled CompressionEnabled

获取或设置一个值,该值指示是否对会话状态数据启用压缩。Gets or sets a value that indicates whether compression is enabled for session-state data.

Cookieless Cookieless Cookieless Cookieless

获取或设置一个值,该值指示是否使用 Cookie 标识客户端会话。Gets or sets a value indicating whether cookies are used to identify client sessions.

CookieName CookieName CookieName CookieName

获取或设置 Cookie 名称。Gets or sets the cookie name.

CookieSameSite CookieSameSite CookieSameSite CookieSameSite

获取或设置 cookie 的 SameSite 属性的值。Gets or sets the value for the SameSite attribute of the cookie.

CurrentConfiguration CurrentConfiguration CurrentConfiguration CurrentConfiguration

获取对顶级 Configuration 实例的引用,该实例表示当前 ConfigurationElement 实例所属的配置层次结构。Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Inherited from ConfigurationElement)
CustomProvider CustomProvider CustomProvider CustomProvider

获取或设置 Providers 集合中的自定义提供程序的名称。Gets or sets the name of the custom provider from the Providers collection.

ElementInformation ElementInformation ElementInformation ElementInformation

获取包含 ConfigurationElement 对象的不可自定义的信息和功能的 ElementInformation 对象。Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Inherited from ConfigurationElement)
ElementProperty ElementProperty ElementProperty ElementProperty

获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EvaluationContext EvaluationContext EvaluationContext EvaluationContext

获取 ConfigurationElement 对象的 ContextInformation 对象。Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext HasContext HasContext HasContext

获取一个值,该值指示 CurrentConfiguration 属性是否为 nullGets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty]

获取或设置此配置元素的属性或特性。Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String] Item[String] Item[String] Item[String]

获取或设置此配置元素的属性、特性或子元素。Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept

获取被锁定的特性的集合。Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept

获取被锁定的元素的集合。Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes LockAttributes LockAttributes LockAttributes

获取被锁定的特性的集合Gets the collection of locked attributes

(Inherited from ConfigurationElement)
LockElements LockElements LockElements LockElements

获取被锁定的元素的集合。Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem LockItem LockItem LockItem

获取或设置一个值,该值指示是否已锁定该元素。Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
Mode Mode Mode Mode

获取或设置一个值,该值指定存储会话状态的位置。Gets or sets a value specifying where to store the session state.

PartitionResolverType PartitionResolverType PartitionResolverType PartitionResolverType

获取或设置一个值,该值指定存储会话状态的位置。Gets or sets a value specifying where to store the session state.

Properties Properties Properties Properties

获取属性的集合。Gets the collection of properties.

(Inherited from ConfigurationElement)
Providers Providers Providers Providers

获取当前的 ProviderSettingsCollection 提供程序。Gets the current ProviderSettingsCollection providers.

RegenerateExpiredSessionId RegenerateExpiredSessionId RegenerateExpiredSessionId RegenerateExpiredSessionId

获取或设置一个值,该值指示当客户端指定过期的会话 ID 时是否重新生成会话 ID。Gets or sets a value indicating whether the session Id will be re-issued when an expired session ID is specified by the client.

SectionInformation SectionInformation SectionInformation SectionInformation

获取一个 SectionInformation 对象,该对象包含 ConfigurationSection 对象的不可自定义的信息和功能。Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object.

(Inherited from ConfigurationSection)
SessionIDManagerType SessionIDManagerType SessionIDManagerType SessionIDManagerType

获取或设置一个值,该值指定会话 ID 管理器的完全限定类型。Gets or sets a value specifying the fully qualified type of session ID Manager.

SqlCommandTimeout SqlCommandTimeout SqlCommandTimeout SqlCommandTimeout

获取或设置使用 SQL Server 会话状态模式的 SQL 命令的超时时间。Gets or sets the duration time-out for the SQL commands using the SQL Server session state mode.

SqlConnectionRetryInterval SqlConnectionRetryInterval SqlConnectionRetryInterval SqlConnectionRetryInterval

获取或设置 ASP.NET 重新连接到数据库之前应经过的时间间隔。Gets or sets the time interval that should elapse before ASP.NET reconnects to the database.

SqlConnectionString SqlConnectionString SqlConnectionString SqlConnectionString

获取或设置 SQL 连接字符串。Gets or sets the SQL connection string.

StateConnectionString StateConnectionString StateConnectionString StateConnectionString

获取或设置状态服务器连接字符串。Gets or sets the state server connection string.

StateNetworkTimeout StateNetworkTimeout StateNetworkTimeout StateNetworkTimeout

获取或设置 Web 服务器和状态服务器间的网络连接可保持空闲的时间量。Gets or sets the amount of time the network connection between the Web server and the state server can remain idle.

Timeout Timeout Timeout Timeout

获取或设置会话超时Gets or sets the session time-out

UseHostingIdentity UseHostingIdentity UseHostingIdentity UseHostingIdentity

获取或设置一个值,该值指定会话状态是在可用时使用客户端模拟,还是始终恢复为承载标识。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.

方法

DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean)

从配置文件读取 XML。Reads XML from the configuration file.

(Inherited from ConfigurationElement)
DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader) DeserializeSection(XmlReader)

从配置文件读取 XML。Reads XML from the configuration file.

(Inherited from ConfigurationSection)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

将当前的 ConfigurationElement 实例与指定的对象进行比较。Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

获取表示当前 ConfigurationElement 实例的唯一值。Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetRuntimeObject() GetRuntimeObject() GetRuntimeObject() GetRuntimeObject()

在派生的类中重写时返回自定义对象。Returns a custom object when overridden in a derived class.

(Inherited from ConfigurationSection)
GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String)

返回指定程序集名称的转换版本。Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String)

返回指定类型名称的转换版本。Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType() GetType() GetType() GetType()

获取当前实例的 TypeGets the Type of the current instance.

(Inherited from Object)
Init() Init() Init() Init()

ConfigurationElement 对象设置为其初始状态。Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault() InitializeDefault() InitializeDefault() InitializeDefault()

用于初始化 ConfigurationElement 对象的默认值集。Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
IsModified() IsModified() IsModified() IsModified()

指示自上次在派生类中实现此配置元素时保存或加载以来是否对其进行过修改。Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.

(Inherited from ConfigurationSection)
IsReadOnly() IsReadOnly() IsReadOnly() IsReadOnly()

获取一个值,该值指示 ConfigurationElement 对象是否为只读。Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList) ListErrors(IList) ListErrors(IList) ListErrors(IList)

将此 ConfigurationElement 对象以及所有子元素中无效属性的错误添加到传递的列表中。Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String)

获取一个值,该值指示反序列化过程中是否遇到未知特性。Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader)

获取一个值,该值指示反序列化过程中是否遇到未知元素。Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String)

找不到所需属性时引发异常。Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize() PostDeserialize() PostDeserialize() PostDeserialize()

反序列化后调用。Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter)

在序列化之前调用。Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement)

重置 ConfigurationElement 对象的内部状态,包括锁和属性集合。Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Inherited from ConfigurationElement)
ResetModified() ResetModified() ResetModified() ResetModified()

在派生类中实现时,将 IsModified() 方法的值重置为 falseResets the value of the IsModified() method to false when implemented in a derived class.

(Inherited from ConfigurationSection)
SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean)

当在派生类中实现后,将此配置元素的内容写入配置文件。Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

创建一个包含 ConfigurationSection 对象的分离视图的 XML 字符串,作为单独的节写入到文件中。Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.

(Inherited from ConfigurationSection)
SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String)

当在派生类中实现后,将此配置元素的外部标记写入配置文件。Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean)

将属性设置为指定值。Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly() SetReadOnly() SetReadOnly() SetReadOnly()

设置 ConfigurationElement 对象及所有子元素的 IsReadOnly() 属性。Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Inherited from ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

指示在为 .NET Framework.NET Framework 的指定目标版本序列化配置对象层次结构时,是否应序列化指定元素。Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Inherited from ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

指示在为指定目标版本的 .NET Framework.NET Framework 序列化配置对象层次结构时,是否应序列化指定属性。Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Inherited from ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName) ShouldSerializeSectionInTargetVersion(FrameworkName)

指示在为指定目标版本的 .NET Framework.NET Framework 序列化配置对象层次结构时,是否应序列化当前的 ConfigurationSection 实例。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.NET Framework.

(Inherited from ConfigurationSection)
ToString() ToString() ToString() ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

修改 ConfigurationElement 对象以移除所有不应该保存的值。Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

适用于

另请参阅