ObjectCache.CreateCacheEntryChangeMonitor Method (IEnumerable(Of String), String)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

When overridden in a derived class, creates a CacheEntryChangeMonitor object that can trigger events in response to changes to specified cache entries.

Namespace:   System.Runtime.Caching
Assembly:  System.Runtime.Caching (in System.Runtime.Caching.dll)

Public MustOverride Function CreateCacheEntryChangeMonitor (
	keys As IEnumerable(Of String),
	regionName As String
) As CacheEntryChangeMonitor

Parameters

keys
Type: System.Collections.Generic.IEnumerable(Of String)

The unique identifiers for cache entries to monitor.

regionName
Type: System.String

Optional. A named region in the cache where the cache keys in the keys parameter exist, if regions are implemented. The default value for the optional parameter is null.

Return Value

Type: System.Runtime.Caching.CacheEntryChangeMonitor

A change monitor that monitors cache entries in the cache.

When a derived ObjectCache class overrides the base CreateCacheEntryChangeMonitor method, the cache implementation must create a CacheEntryChangeMonitor object. This specialized change monitor notifies callers when there are changes to the cache entries that are specified in the keys parameter. For example, if a monitored item in the keys parameter is updated or removed from the cache, the change monitor created by this method triggers an event.

If a cache implementation supports named cache regions, a string value can be specified as the regionName parameter. Otherwise, the parameter defaults to null.

System_CAPS_noteNote

Not all cache implementations support cache-entry change monitors. To determine whether your cache implementation supports CacheEntryChangeMonitor objects, see the documentation for the specific cache implementation.

.NET Framework
Available since 4.0
Return to top
Show: