CacheManager.RefreshInterval Property (PIA)

Article
11/12/2009

The RefreshInterval property is a read/write Integer that specifies the approximate number of seconds between automatic cache refresh operations on a specified cache.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Property RefreshInterval(bstrName As String) As Integer

[C#]

Get method:

using Microsoft.CommerceServer.Interop.Caching;
…
public int get_RefreshInterval(stringbstrName);

Put method:

public void set_RefreshInterval(stringbstrName,
 intplRefresh);

Parameters

[Visual Basic .NET]

bstrName
A String that contains the name of a data cache for which the refresh interval is being provided or retrieved.

[C#]

bstrName
A string that contains the name of a data cache for which the refresh interval is being provided or retrieved.
plRefresh
When setting the property, an int that contains the new refresh interval value.

Return Values

When getting, an int with the refresh interval.

Exceptions

This property may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

A refresh interval value of zero (0) means that the cache is never refreshed automatically.

The default refresh interval value is zero (0).

The value is a measurement of the number of seconds between automatic cache refresh operations.

[C#] The get_RefreshInterval and set_RefreshInterval methods do not show up in IntelliSense.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

Share via