CacheEntryUpdateArguments Class

.NET Framework (current version)

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

Provides information about a cache entry that will be removed from the cache.

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


public class CacheEntryUpdateArguments

System_CAPS_pubmethodCacheEntryUpdateArguments(ObjectCache, CacheEntryRemovedReason, String, String)

Initializes a new instance of the CacheEntryUpdateArguments class.


Gets the unique identifier for a cache entry that is about to be removed.


Gets the name of a region in the cache that contains a cache entry.


Gets the reason that a cache entry is about to be removed from the cache.


Gets a reference to the ObjectCache instance that contains a cache entry that is about to be removed.


Gets or sets the value of CacheItem entry that is used to update the cache object.


Gets or sets the cache eviction or expiration policy of the CacheItem entry that is updated.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

The arguments in the CacheEntryUpdateArguments class contain details about an entry that the cache implementation is about to remove. The arguments include a key to the cache entry, a reference to the ObjectCache instance that the entry will be removed from, a reason for the removal, and the region name in the cache that contains the entry. The constructor of the CacheEntryUpdateArguments class uses these arguments to create a new instance of the class.

A CacheEntryUpdateArguments object is passed to a CacheEntryUpdateCallback handler, which notifies the cache about the entry to remove.

Notes to Implementers:

A callback handler must notify the cache implementation whether to insert a replacement entry into the cache in place of the cache entry that is about to be removed. If you want to exchange cache entries, you must assign a value other than null to the UpdatedCacheItem property. Cache implementations will interpret a null value for the UpdatedCacheItem property as a notice that the current cache entry should be removed but not replaced.

.NET Framework
Available since 4.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top