214 lines
12 KiB
XML
214 lines
12 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="CacheSection" FullName="System.Web.Configuration.CacheSection">
|
||
|
|
<TypeSignature Language="C#" Value="public sealed class CacheSection : System.Configuration.ConfigurationSection" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Web</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Configuration.ConfigurationSection</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="T:System.Web.Configuration.CacheSection" /> class provides a way to programmatically access and modify the <cache> section of a configuration file.</para>
|
||
|
|
<para>The ASP.NET caching feature is implemented by the <see cref="T:System.Web.Caching.Cache" /> class. For more information, see <format type="text/html"><a href="ac11c8ea-df5d-4de8-b315-9ccf1048b0ce">ASP.NET Caching Features</a></format>. </para>
|
||
|
|
<block subset="none" type="note">
|
||
|
|
<para>The <see cref="T:System.Web.Configuration.CacheSection" /> can write information into the related section of the configuration file according to the restrictions defined by the section property <see cref="P:System.Configuration.SectionInformation.AllowDefinition" /> whose value is <see cref="F:System.Configuration.ConfigurationAllowDefinition.MachineToApplication" />. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy.</para>
|
||
|
|
</block>
|
||
|
|
<para>A cache is an application-specific hash table used to store frequently accessed data. Application and session state are similar to the cache, the application state being the most similar, due to its application-wide scope. One of the biggest differences between the cache and the application-state mechanism is that the cache supports dependencies These dependencies make it possible to build applications that automatically remove cached items when certain events occur. </para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Configures the global cache settings for an ASP.NET application. This class cannot be inherited.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public CacheSection ();" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="M:System.Web.Configuration.CacheSection.#ctor" /> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the <see cref="T:System.Web.Configuration.CacheSection" /> class by using the <see cref="M:System.Configuration.Configuration.GetSection(System.String)" /> method.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.CacheSection" /> class.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="DisableExpiration">
|
||
|
|
<MemberSignature Language="C#" Value="public bool DisableExpiration { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.ConfigurationProperty("disableExpiration", DefaultValue="False")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the <see cref="P:System.Web.Configuration.CacheSection.DisableExpiration" /> property is set to true, the cached items never expire. This setting is intended to help debug cache behavior in application code. Use caution when disabling cache expiration, as this might result in items being cached longer than they are valid.</para>
|
||
|
|
<block subset="none" type="note">
|
||
|
|
<para>To add a page to the output cache, you must establish an expiration policy for that page. You can do this declaratively with the <format type="text/html"><a href="28a9e101-fb44-4198-9cb6-b8a52312fec2">@ OutputCache</a></format> directive or programmatically using the <see cref="M:System.Web.HttpCachePolicy.SetExpires(System.DateTime)" /> method. For more information, see <format type="text/html"><a href="c8931600-b167-477d-bd5a-0186ac908646">How to: Set Expirations for Page Caching</a></format>.</para>
|
||
|
|
</block>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating whether the cache expiration is disabled.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="DisableMemoryCollection">
|
||
|
|
<MemberSignature Language="C#" Value="public bool DisableMemoryCollection { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.ConfigurationProperty("disableMemoryCollection", DefaultValue="False")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the <see cref="P:System.Web.Configuration.CacheSection.DisableMemoryCollection" /> property is set to true, calls to the cache-related API will have no effect.</para>
|
||
|
|
<para>If the <see cref="P:System.Web.Configuration.CacheSection.DisableMemoryCollection" /> property is set to true, the cache does not attempt to collect unused items. Use caution when using this setting, as disabling memory collection can quickly lead to Out of Memory conditions for the application. </para>
|
||
|
|
<para>This setting has no effect on the ASP.NET internal cache or on the output cache. For more information about the different types of cache, see <format type="text/html"><a href="ac11c8ea-df5d-4de8-b315-9ccf1048b0ce">ASP.NET Caching Features</a></format>.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating whether the cache memory collection is disabled.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="PercentagePhysicalMemoryUsedLimit">
|
||
|
|
<MemberSignature Language="C#" Value="public int PercentagePhysicalMemoryUsedLimit { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.ConfigurationProperty("percentagePhysicalMemoryUsedLimit", DefaultValue="0")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.IntegerValidator(MinValue=0, MaxValue=100)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Int32</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.Configuration.CacheSection.PercentagePhysicalMemoryUsedLimit" /> property specifies the threshold for high pressure conditions. As this threshold is approached, the cache system gradually begins more aggressive scavenging measures.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating the maximum percentage of virtual memory usage.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="PrivateBytesLimit">
|
||
|
|
<MemberSignature Language="C#" Value="public long PrivateBytesLimit { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.ConfigurationProperty("privateBytesLimit", DefaultValue="0")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.LongValidator(MinValue=0, MaxValue=9223372036854775807)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Int64</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.Configuration.CacheSection.PrivateBytesLimit" /> property specifies the threshold for high pressure conditions. As this threshold is approached, the cache system gradually begins more aggressive scavenging measures.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating the maximum size of the working-process private space.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="PrivateBytesPollTime">
|
||
|
|
<MemberSignature Language="C#" Value="public TimeSpan PrivateBytesPollTime { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.Configuration.ConfigurationProperty("privateBytesPollTime", DefaultValue="00:02:00")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Configuration.InfiniteTimeSpanConverter))</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.TimeSpan</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>This polling is expensive and might need to be adjusted as a tradeoff between reaction speed of the cache-trimming algorithm and number of polling calls made.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating the time interval between polling for the worker-process memory usage.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="Properties">
|
||
|
|
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<summary>To be added.</summary>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|