CachingProfileElement 类

为给定的请求扩展配置缓存。

语法

class CachingProfileElement : CollectionElement  

方法

此类不包含任何方法。

属性

下表列出了 CachingProfileElement 类公开的属性。

名称 描述
Duration 读/写 datetime 值,用于指定响应在缓存中的保留时间。 默认值为 30 秒。 有效时间范围为 0 至 365 天。
Extension 必需的唯一读/写 string 值,用于指定将使用缓存配置文件的请求的扩展名。 该扩展名必须采用“EXT”或“*”格式,其中 EXT 是扩展名。 键属性。 注意:不允许扩展名重叠的条目。 每个请求正好映射到一个 CachingProfileElement 对象。 如果存在带“*”的条目,其他具有更具体扩展的缓存配置文件将覆盖带星号的配置文件。 配置文件条目的顺序并不重要。
KernelCachePolicy 读/写 sint32 值,用于配置内核缓存策略。 后文的“注解”部分列出了可能的值。
Location 读/写 sint32 值,用于指定输出缓存的可能位置。 后文的“注解”部分列出了可能的值。
Policy 读/写 sint32 值,用于配置输出缓存策略。 后文的“注解”部分列出了可能的值。
VaryByHeaders 读/写 string 值,包含一个以逗号分隔的标头名称列表,服务器将使用这些名称来更改对 URL 的缓存响应。
VaryByQueryString 读/写 string 值,包含一个以逗号分隔的查询字符串参数列表,服务器将使用这些参数来更改对 URL 的缓存响应。

子类

此类不包含子类。

注解

此类与 ApplicationHost.config 文件中 <system.webServer/caching> 部分下的 <profiles> 元素相对应。 此类的实例包含在 CachingProfileSettings 类的 Profiles 数组属性中。

下表列出了 KernelCachePolicy 属性的可能值。 默认值为 0 (DontCache)。

关键字 说明
0 DontCache 响应不会缓存在内核中。 但是,仍可能发生输出缓存。 注意:此设置会覆盖 Location 属性中的任何冲突设置
1 CacheUntilChange 响应将缓存在 HTTP.SYS 缓存中,直到条目失效或在 Duration 属性指定的非活动期后过期。
2 CacheForTimePeriod 响应在 Duration 属性指定的时间内缓存,即使在此期间条目失效。
3 DisableCache 缓存已禁用,不会发生缓存。

下表列出了 Location 属性的可能值。 默认值为 3 (Server)。

关键字 说明
0 Any 响应可在客户端、网络服务器或代理服务器上缓存。
1 Client 响应仅在客户端上缓存。
2 Downstream 响应在代理服务器和客户端上缓存,但不在网络服务器上缓存。
3 Server 响应仅在 Web 服务器上缓存。
4 None 响应不在任何地方缓存。
5 ServerAndClient 响应在 Web 服务器和客户端上缓存,但不在代理服务器上缓存。 注意:当服务器对专用内容有不同行为时,可以使用此设置避免代理缓存上的多个用户共享内容

下表列出了 Policy 属性的可能值。 默认值为 0 (DontCache)。

关键字 说明
0 DontCache 响应不会放入输出缓存。 但是,内核缓存仍可能发生。
1 CacheUntilChange 响应会被缓存,直到条目失效或在 Duration 属性指定的非活动期后过期。
2 CacheForTimePeriod 响应在 Duration 属性指定的时间内缓存,即使在此期间条目失效。
3 DisableCache 缓存已禁用,不会发生缓存。

示例

下面的示例显示了默认网站的所有 CachingProfileElement 对象。

' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Get the caching section for the default Web site.  
Set oSite = oWebAdmin.Get("Site.Name='Default Web Site'")  
oSite.GetSection "CachingSection", oSection  

' Display the path and location.  
Wscript.Echo "Path: " & oSection.Path  
Wscript.Echo "Location: " & oSection.Location  
Wscript.Echo

' Display all of the caching profiles for the default Web site.  
For Each oCachingProfileElement In oSection.Profiles.Profiles  
    Wscript.Echo
    WScript.Echo "[ " & oCachingProfileElement.Extension & _  
        " ] Caching Profile"  
    WScript.Echo "-----------------------------------"  
    WScript.Echo "Duration: " & oCachingProfileElement.Duration  
    WScript.Echo "KernelCachePolicy: " & _  
        CachePolicyText(oCachingProfileElement.KernelCachePolicy)  
    WScript.Echo "Location: " & _  
        LocationText(oCachingProfileElement.Location)  
    WScript.Echo "Policy: " & _  
        CachePolicyText(oCachingProfileElement.Policy)  
    WScript.Echo "VaryByHeaders: " & _  
        oCachingProfileElement.VaryByHeaders  
    WScript.Echo "VaryByQueryString: " & _  
        oCachingProfileElement.VaryByQueryString  
    WScript.Echo
Next  

' Provide text for KernelCachePolicy and Policy enumeration values.  
Function CachePolicyText(enumval)  

    Select Case enumval  
        Case 0  
            CachePolicyText="DontCache"  
        Case 1  
            CachePolicyText="CacheUntilChange"  
        Case 2  
            CachePolicyText="CacheForTimePeriod"  
        Case 3  
            CachePolicyText="DisableCache"  
        Case Else  
            CachePolicyText="Undefined enumeration value"  
    End Select  

End Function  

' Provide text for Location enumeration values.  
Function LocationText(enumval)  

    Select Case enumval  
        Case 0  
            LocationText="Any"  
        Case 1  
            LocationText="Client"  
        Case 2  
            GetLocationText="Downstream"  
        Case 3  
            LocationText="Server"  
        Case 4  
            LocationText="None"  
        Case 5  
            LocationText="ServerAndClient"  
        Case Else  
            LocationText="Undefined enumeration value"  
    End Select  

End Function

继承层次结构

CollectionElement

CachingProfileElement

要求

类型 描述
客户端 - IIS 7.0(在 Windows Vista 上)
- IIS 7.5(在 Windows 7 上)
- IIS 8.0(在 Windows 8 上)
- IIS 10.0(在 Windows 10 上)
服务器 - IIS 7.0(在 Windows Server 2008 上)
- IIS 7.5(在 Windows Server 2008 R2 上)
- IIS 8.0(在 Windows Server 2012 上)
- IIS 8.5(在 Windows Server 2012 R2 上)
- IIS 10.0(在 Windows Server 2016 上)
产品 - IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0
MOF 文件 WebAdministration.mof

另请参阅

AspCache 类
CachingProfileSettings 类
CachingSection 类
CollectionElement 类
HttpClientCache 类