Share via

CacheManager.RefreshCache Method (PIA)

  • Article

Use this method to force an immediate refresh of a data cache Dictionary object. This method is synchronous, not returning to the caller until the specified data cache is refreshed.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Sub RefreshCache(bstrName As String)

[C#]

using Microsoft.CommerceServer.Interop.Caching;
…
public void RefreshCache(stringbstrName);

Parameters

[Visual Basic .NET]

  • bstrName
    A String that contains the name of the data cache to be refreshed.

[C#]

  • bstrName
    A string that contains the name of the data cache to be refreshed.

Exceptions

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

Remarks

If the specified cache is in the middle of being refreshed when the RefreshCache method is invoked, presumably by the background timer thread or a different foreground thread, this method will wait until the refresh operation is complete and then return. It will not result in another refresh operation.

[Visual Basic .NET]

Example

'strMyCacheName is a String containing the name of an existing cache.
myCacheManager.RefreshCache(strMyCacheName)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

See Also

CacheManager Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.