Share via


FPCCacheConfiguration object

Applies to: desktop apps only

The FPCCacheConfiguration object provides access to the cache configuration settings in a Forefront TMG array. It also provides access to the active cache configuration settings because it is a container for the FPCActiveCacheConfiguration object.

Note  To disable the cache in an array, you have to set the CacheLimitInMegs property of the FPCCacheDrive object to zero for all drives on all servers in the array. If there is cache space allocated on any drive, the cache is automatically enabled.

The FPCCacheConfiguration object is accessed through the CacheConfiguration property of an FPCCache object.

Ff824371.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

For more information about the COM objects related to caching, see Introduction to the Forefront TMG Cache Objects.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting an object's data to and importing it from an XML document.

Members

The FPCCacheConfiguration object has these types of members:

  • Properties

Properties

The FPCCacheConfiguration object has these properties.

Property Access type Description

ActiveCacheConfiguration

Read-only

Gets an FPCActiveCacheConfiguration object for accessing the active cache configuration.

CacheNon200Responses

Read/write

Gets or sets a Boolean value that indicates whether the caching of responses having a code other than 200 (OK) is enabled.

CacheRules

Read-only

Gets an FPCCacheRules collection that contains the cache rules which are applied.

CacheWithNoLastModDate

Read/write

Gets or sets a Boolean value that indicates whether the caching of responses that have no last-modified date is enabled.

MemoryCacheMaxURLSize

Read/write

Gets or sets the maximum size of an object that may be stored in the physical memory cache.

MemoryUsagePercentage

Read/write

Gets or sets the percentage of physical memory that may be used for caching.

QueueRequests

Read/write

Gets or sets a Boolean value that indicates whether requests for objects are queued if those objects are in the process of being stored in the cache.

ReturnExpiredEnable

Read/write

Gets or sets a Boolean value that indicates whether the Forefront TMG Web proxy returns expired cached objects when an updated object cannot be retrieved, or issues an error response.

ReturnExpiredMaxTime

Read/write

Gets or sets the maximum time, in minutes, during which an expired cached object may be returned if the returning of expired cached objects is enabled.

ReturnExpiredTTLPercent

Read/write

Gets or sets the percentage of an expired cached object's Time to Live (TTL) during which the object may be returned if the returning of expired cached objects is enabled.

 

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name Description
PersistentName Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCCacheConfiguration interface.

Requirements

Minimum supported client

Windows Vista, None supported

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)

Version

Forefront Threat Management Gateway (TMG) 2010

IDL

Msfpccom.idl

See also

COM Objects

 

 

Build date: 7/12/2010