This documentation is archived and is not being maintained.

CacheEntryUpdateArguments Class

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

The CacheEntryUpdateArguments type exposes the following members.

Public methodCacheEntryUpdateArgumentsInitializes a new instance of the CacheEntryUpdateArguments class.

Public propertyKeyGets the unique identifier for a cache entry that is about to be removed.
Public propertyRegionNameGets the name of a region in the cache that contains a cache entry.
Public propertyRemovedReasonGets the reason that a cache entry is about to be removed from the cache.
Public propertySourceGets a reference to the ObjectCache instance that contains a cache entry that is about to be removed.
Public propertyUpdatedCacheItemGets or sets the value of CacheItem entry that is used to update the cache object.
Public propertyUpdatedCacheItemPolicyGets or sets the cache eviction or expiration policy of the CacheItem entry that is updated.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns 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

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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