linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.SessionState/SessionStateStoreData.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="SessionStateStoreData" FullName="System.Web.SessionState.SessionStateStoreData">
  <TypeSignature Language="C#" Value="public class SessionStateStoreData" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> class is used by ASP.NET and implementers of a custom session-state store to pass session-state information to and from the <see cref="T:System.Web.SessionState.SessionStateModule" />.</para>
      <para>The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> class is used to represent session-state data for a session store to the <see cref="T:System.Web.SessionState.SessionStateModule" />. The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> object contains the session-state variable names and values, static object references, and <see cref="P:System.Web.SessionState.SessionStateStoreData.Timeout" /> information for the current session.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents session-state data for a session store.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SessionStateStoreData (System.Web.SessionState.ISessionStateItemCollection items, System.Web.HttpStaticObjectsCollection objects, int timeout);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="items" Type="System.Web.SessionState.ISessionStateItemCollection" />
        <Parameter Name="objects" Type="System.Web.HttpStaticObjectsCollection" />
        <Parameter Name="timeout" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="items">To be added.</param>
        <param name="objects">To be added.</param>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> class is used to represent session-state data for a session store to the <see cref="T:System.Web.SessionState.SessionStateModule" />. The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> object contains the session-state variable names and values, static object references, and <see cref="P:System.Web.SessionState.SessionStateStoreData.Timeout" /> information for the current session.</para>
          <para>The <see cref="T:System.Web.SessionState.SessionStateStoreData" /> class is used by ASP.NET and implementers of a custom session-state store to pass session-state information to and from the <see cref="T:System.Web.SessionState.SessionStateModule" />.</para>
          <para>Custom session-store implementers construct a <see cref="T:System.Web.SessionState.SessionStateStoreData" /> object in implementations of the <see cref="M:System.Web.SessionState.SessionStateStoreProviderBase.GetItem(System.Web.HttpContext,System.String,System.Boolean@,System.TimeSpan@,System.Object@,System.Web.SessionState.SessionStateActions@)" />, <see cref="M:System.Web.SessionState.SessionStateStoreProviderBase.GetItemExclusive(System.Web.HttpContext,System.String,System.Boolean@,System.TimeSpan@,System.Object@,System.Web.SessionState.SessionStateActions@)" />, and <see cref="M:System.Web.SessionState.SessionStateStoreProviderBase.CreateNewStoreData(System.Web.HttpContext,System.Int32)" /> methods.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Creates a new instance of the <see cref="T:System.Web.SessionState.SessionStateStoreData" /> class.</para>
        </summary>
        <param name="timeout">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Web.SessionState.SessionStateStoreData.Timeout" /> for the current session.</param>
      </Docs>
    </Member>
    <Member MemberName="Items">
      <MemberSignature Language="C#" Value="public virtual System.Web.SessionState.ISessionStateItemCollection Items { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.SessionState.ISessionStateItemCollection</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.SessionState.SessionStateStoreData.Items" /> property references the session-state variables that are exposed to ASP.NET application code using the <see cref="T:System.Web.SessionState.HttpSessionState" /> class, which is accessed using the <see cref="P:System.Web.HttpContext.Session" /> property of the current <see cref="T:System.Web.HttpContext" /> or the <see cref="T:System.Web.UI.Page" /> instance.</para>
          <para>By default, session-state variables are managed using the <see cref="T:System.Web.SessionState.SessionStateItemCollection" /> object. Custom session-store implementers can supply their own implementation of the <see cref="T:System.Web.SessionState.ISessionStateItemCollection" /> interface.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The session variables and values for the current session.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="StaticObjects">
      <MemberSignature Language="C#" Value="public virtual System.Web.HttpStaticObjectsCollection StaticObjects { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.HttpStaticObjectsCollection</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The</para>
          <para>
            <see cref="P:System.Web.SessionState.SessionStateStoreData.StaticObjects" /> property is provided for compatibility with earlier versions of ASP.</para>
          <para>Custom session-store implementers can obtain a reference to the <see cref="T:System.Web.HttpStaticObjectsCollection" /> class for the current <see cref="T:System.Web.HttpContext" /> instance using the <see cref="M:System.Web.SessionState.SessionStateUtility.GetSessionStaticObjects(System.Web.HttpContext)" /> method.</para>
          <block subset="none" type="note">
            <para>Custom objects stored in the <see cref="P:System.Web.SessionState.SessionStateStoreData.StaticObjects" /> collection must support binary serialization. For more information, see <format type="text/html"><a href="2b1ea3be-1152-4032-b2b3-07794054c405">Binary Serialization</a></format>.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a collection of objects declared by &lt;object Runat="Server" Scope="Session"/&gt; tags within the ASP.NET application file Global.asax.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Timeout">
      <MemberSignature Language="C#" Value="public virtual int Timeout { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets and sets the amount of time, in minutes, allowed between requests before the session-state provider terminates the session.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>